AWS code-library documentation change
Summary
Removed Java and Python code examples demonstrating how to list batch jobs using Amazon S3 Control SDKs
Security assessment
The change removes general code examples for listing batch jobs but contains no references to security vulnerabilities, patches, or security-related configurations. The deleted content focused on basic SDK usage without addressing security features or vulnerabilities.
Diff
diff --git a/code-library/latest/ug/s3-control_code_examples.md b/code-library/latest/ug/s3-control_code_examples.md index 22a2e27af..61480adfb 100644 --- a//code-library/latest/ug/s3-control_code_examples.md +++ b//code-library/latest/ug/s3-control_code_examples.md @@ -28,176 +27,0 @@ _Actions_ are code excerpts from larger programs and must be run in context. Whi -**Get started** - -The following code examples show how to get started using Amazon S3 Control. - -Java - - -**SDK for Java 2.x** - - -###### Note - -There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/s3/src/main/java/com/example/s3/batch#code-examples). - - - import software.amazon.awssdk.auth.credentials.EnvironmentVariableCredentialsProvider; - import software.amazon.awssdk.core.client.config.ClientOverrideConfiguration; - import software.amazon.awssdk.core.retry.RetryMode; - import software.amazon.awssdk.core.retry.RetryPolicy; - import software.amazon.awssdk.http.async.SdkAsyncHttpClient; - import software.amazon.awssdk.http.nio.netty.NettyNioAsyncHttpClient; - import software.amazon.awssdk.regions.Region; - import software.amazon.awssdk.services.s3control.S3ControlAsyncClient; - import software.amazon.awssdk.services.s3control.model.JobListDescriptor; - import software.amazon.awssdk.services.s3control.model.JobStatus; - import software.amazon.awssdk.services.s3control.model.ListJobsRequest; - import software.amazon.awssdk.services.s3control.paginators.ListJobsPublisher; - import java.time.Duration; - import java.util.List; - import java.util.concurrent.CompletableFuture; - import java.util.concurrent.CompletionException; - - /** - * Before running this example: - * <p/> - * The SDK must be able to authenticate AWS requests on your behalf. If you have not configured - * authentication for SDKs and tools,see https://docs.aws.amazon.com/sdkref/latest/guide/access.html in the AWS SDKs and Tools Reference Guide. - * <p/> - * You must have a runtime environment configured with the Java SDK. - * See https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/setup.html in the Developer Guide if this is not set up. - */ - public class HelloS3Batch { - private static S3ControlAsyncClient asyncClient; - - public static void main(String[] args) { - S3BatchActions actions = new S3BatchActions(); - String accountId = actions.getAccountId(); - try { - listBatchJobsAsync(accountId) - .exceptionally(ex -> { - System.err.println("List batch jobs failed: " + ex.getMessage()); - return null; - }) - .join(); - - } catch (CompletionException ex) { - System.err.println("Failed to list batch jobs: " + ex.getMessage()); - } - } - - /** - * Retrieves the asynchronous S3 Control client instance. - * <p> - * This method creates and returns a singleton instance of the {@link S3ControlAsyncClient}. If the instance - * has not been created yet, it will be initialized with the following configuration: - * <ul> - * <li>Maximum concurrency: 100</li> - * <li>Connection timeout: 60 seconds</li> - * <li>Read timeout: 60 seconds</li> - * <li>Write timeout: 60 seconds</li> - * <li>API call timeout: 2 minutes</li> - * <li>API call attempt timeout: 90 seconds</li> - * <li>Retry policy: 3 retries</li> - * <li>Region: US_EAST_1</li> - * <li>Credentials provider: {@link EnvironmentVariableCredentialsProvider}</li> - * </ul> - * - * @return the asynchronous S3 Control client instance - */ - private static S3ControlAsyncClient getAsyncClient() { - if (asyncClient == null) { - SdkAsyncHttpClient httpClient = NettyNioAsyncHttpClient.builder() - .maxConcurrency(100) - .connectionTimeout(Duration.ofSeconds(60)) - .readTimeout(Duration.ofSeconds(60)) - .writeTimeout(Duration.ofSeconds(60)) - .build(); - - ClientOverrideConfiguration overrideConfig = ClientOverrideConfiguration.builder() - .apiCallTimeout(Duration.ofMinutes(2)) - .apiCallAttemptTimeout(Duration.ofSeconds(90)) - .retryStrategy(RetryMode.STANDARD) - .build(); - - asyncClient = S3ControlAsyncClient.builder() - .region(Region.US_EAST_1) - .httpClient(httpClient) - .overrideConfiguration(overrideConfig) - .build(); - } - return asyncClient; - } - - /** - * Asynchronously lists batch jobs that have completed for the specified account. - * - * @param accountId the ID of the account to list jobs for - * @return a CompletableFuture that completes when the job listing operation is finished - */ - public static CompletableFuture<Void> listBatchJobsAsync(String accountId) { - ListJobsRequest jobsRequest = ListJobsRequest.builder() - .jobStatuses(JobStatus.COMPLETE) - .accountId(accountId) - .maxResults(10) - .build(); - - ListJobsPublisher publisher = getAsyncClient().listJobsPaginator(jobsRequest); - return publisher.subscribe(response -> { - List<JobListDescriptor> jobs = response.jobs(); - for (JobListDescriptor job : jobs) { - System.out.println("The job id is " + job.jobId()); - System.out.println("The job priority is " + job.priority()); - } - }).thenAccept(response -> { - System.out.println("Listing batch jobs completed"); - }).exceptionally(ex -> { - System.err.println("Failed to list batch jobs: " + ex.getMessage()); - throw new RuntimeException(ex); - }); - } - - - - * For API details, see [ListJobs](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/ListJobs) in _AWS SDK for Java 2.x API Reference_. - - - - -Python - - -**SDK for Python (Boto3)** - - -###### Note - -There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/s3/scenarios/batch#code-examples). - - - def list_jobs(self, account_id: str) -> None: - """ - List all batch jobs for the account. - - Args: - account_id (str): AWS account ID - """ - try: - response = self.s3control_client.list_jobs( - AccountId=account_id, - JobStatuses=['Active', 'Complete', 'Cancelled', 'Failed', 'New', 'Paused', 'Pausing', 'Preparing', 'Ready', 'Suspended'] - ) - jobs = response.get('Jobs', []) - for job in jobs: - print(f"The job id is {job['JobId']}") - print(f"The job priority is {job['Priority']}") - except ClientError as e: - print(f"Error listing jobs: {e}") - raise - - - - * For API details, see [ListJobs](https://docs.aws.amazon.com/goto/boto3/s3control-2018-08-20/ListJobs) in _AWS SDK for Python (Boto3) API Reference_. - - - -