Change S3 types to v2.
software.amazon.awssdk.v2migration.S3TypesToV2
Change S3 types to v2.
Recipe source
GitHub, Issue Tracker, Maven Central
This recipe is composed of more than one recipe. If you want to customize the set of recipes this is composed of, you can find and copy the GitHub source for the recipe from the link above.
This recipe is available under the Apache License Version 2.0.
Definition
- Recipe List
- Yaml Recipe List
- Change method invocation return type
- methodPattern:
com.amazonaws.services.s3.AmazonS3 getObject(com.amazonaws.services.s3.model.GetObjectRequest, java.io.File)
- newReturnType:
software.amazon.awssdk.services.s3.model.GetObjectResponse
- methodPattern:
- Change method invocation return type
- methodPattern:
com.amazonaws.services.s3.AmazonS3 getBucketAcl(..)
- newReturnType:
software.amazon.awssdk.services.s3.model.GetBucketAclResponse
- methodPattern:
- Change method invocation return type
- methodPattern:
com.amazonaws.services.s3.AmazonS3 getObjectAcl(..)
- newReturnType:
software.amazon.awssdk.services.s3.model.GetObjectAclResponse
- methodPattern:
- Change method invocation return type
- methodPattern:
com.amazonaws.services.s3.AmazonS3 getBucketAccelerateConfiguration(..)
- newReturnType:
software.amazon.awssdk.services.s3.model.GetBucketAccelerateConfigurationResponse
- methodPattern:
- Change method invocation return type
- methodPattern:
com.amazonaws.services.s3.AmazonS3 getBucketLifecycleConfiguration(..)
- newReturnType:
software.amazon.awssdk.services.s3.model.GetBucketLifecycleConfigurationResponse
- methodPattern:
- Change method invocation return type
- methodPattern:
com.amazonaws.services.s3.AmazonS3 getBucketCrossOriginConfiguration(..)
- newReturnType:
software.amazon.awssdk.services.s3.model.GetBucketCorsResponse
- methodPattern:
- Change method invocation return type
- methodPattern:
com.amazonaws.services.s3.AmazonS3 getBucketLoggingConfiguration(..)
- newReturnType:
software.amazon.awssdk.services.s3.model.GetBucketLoggingResponse
- methodPattern:
- Change method invocation return type
- methodPattern:
com.amazonaws.services.s3.AmazonS3 getBucketNotificationConfiguration(..)
- newReturnType:
software.amazon.awssdk.services.s3.model.GetBucketNotificationConfigurationResponse
- methodPattern:
- Change method invocation return type
- methodPattern:
com.amazonaws.services.s3.AmazonS3 getBucketPolicy(..)
- newReturnType:
software.amazon.awssdk.services.s3.model.GetBucketPolicyResponse
- methodPattern:
- Change method invocation return type
- methodPattern:
com.amazonaws.services.s3.AmazonS3 getBucketReplicationConfiguration(..)
- newReturnType:
software.amazon.awssdk.services.s3.model.GetBucketReplicationResponse
- methodPattern:
- Change method invocation return type
- methodPattern:
com.amazonaws.services.s3.AmazonS3 getBucketTaggingConfiguration(..)
- newReturnType:
software.amazon.awssdk.services.s3.model.GetBucketTaggingResponse
- methodPattern:
- Change method invocation return type
- methodPattern:
com.amazonaws.services.s3.AmazonS3 getBucketVersioningConfiguration(..)
- newReturnType:
software.amazon.awssdk.services.s3.model.GetBucketVersioningResponse
- methodPattern:
- Change method invocation return type
- methodPattern:
com.amazonaws.services.s3.AmazonS3 getBucketWebsiteConfiguration(..)
- newReturnType:
software.amazon.awssdk.services.s3.model.GetBucketWebsiteResponse
- methodPattern:
- Change method invocation return type
- methodPattern:
com.amazonaws.services.s3.AmazonS3Client getObject(com.amazonaws.services.s3.model.GetObjectRequest, java.io.File)
- newReturnType:
software.amazon.awssdk.services.s3.model.GetObjectResponse
- methodPattern:
- Change method invocation return type
- methodPattern:
com.amazonaws.services.s3.AmazonS3Client getBucketAcl(..)
- newReturnType:
software.amazon.awssdk.services.s3.model.GetBucketAclResponse
- methodPattern:
- Change method invocation return type
- methodPattern:
com.amazonaws.services.s3.AmazonS3Client getObjectAcl(..)
- newReturnType:
software.amazon.awssdk.services.s3.model.GetObjectAclResponse
- methodPattern:
- Change method invocation return type
- methodPattern:
com.amazonaws.services.s3.AmazonS3Client getBucketAccelerateConfiguration(..)
- newReturnType:
software.amazon.awssdk.services.s3.model.GetBucketAccelerateConfigurationResponse
- methodPattern:
- Change method invocation return type
- methodPattern:
com.amazonaws.services.s3.AmazonS3Client getBucketLifecycleConfiguration(..)
- newReturnType:
software.amazon.awssdk.services.s3.model.GetBucketLifecycleConfigurationResponse
- methodPattern:
- Change method invocation return type
- methodPattern:
com.amazonaws.services.s3.AmazonS3Client getBucketCrossOriginConfiguration(..)
- newReturnType:
software.amazon.awssdk.services.s3.model.GetBucketCorsResponse
- methodPattern:
- Change method invocation return type
- methodPattern:
com.amazonaws.services.s3.AmazonS3Client getBucketLoggingConfiguration(..)
- newReturnType:
software.amazon.awssdk.services.s3.model.GetBucketLoggingResponse
- methodPattern:
- Change method invocation return type
- methodPattern:
com.amazonaws.services.s3.AmazonS3Client getBucketNotificationConfiguration(..)
- newReturnType:
software.amazon.awssdk.services.s3.model.GetBucketNotificationConfigurationResponse
- methodPattern:
- Change method invocation return type
- methodPattern:
com.amazonaws.services.s3.AmazonS3Client getBucketPolicy(..)
- newReturnType:
software.amazon.awssdk.services.s3.model.GetBucketPolicyResponse
- methodPattern:
- Change method invocation return type
- methodPattern:
com.amazonaws.services.s3.AmazonS3Client getBucketReplicationConfiguration(..)
- newReturnType:
software.amazon.awssdk.services.s3.model.GetBucketReplicationResponse
- methodPattern:
- Change method invocation return type
- methodPattern:
com.amazonaws.services.s3.AmazonS3Client getBucketTaggingConfiguration(..)
- newReturnType:
software.amazon.awssdk.services.s3.model.GetBucketTaggingResponse
- methodPattern:
- Change method invocation return type
- methodPattern:
com.amazonaws.services.s3.AmazonS3Client getBucketVersioningConfiguration(..)
- newReturnType:
software.amazon.awssdk.services.s3.model.GetBucketVersioningResponse
- methodPattern:
- Change method invocation return type
- methodPattern:
com.amazonaws.services.s3.AmazonS3Client getBucketWebsiteConfiguration(..)
- newReturnType:
software.amazon.awssdk.services.s3.model.GetBucketWebsiteResponse
- methodPattern:
---
type: specs.openrewrite.org/v1beta/recipe
name: software.amazon.awssdk.v2migration.S3TypesToV2
displayName: Change S3 types to v2.
description: |
Change S3 types to v2.
recipeList:
- software.amazon.awssdk.v2migration.openrewrite.ChangeMethodInvocationReturnType:
methodPattern: com.amazonaws.services.s3.AmazonS3 getObject(com.amazonaws.services.s3.model.GetObjectRequest, java.io.File)
newReturnType: software.amazon.awssdk.services.s3.model.GetObjectResponse
- software.amazon.awssdk.v2migration.openrewrite.ChangeMethodInvocationReturnType:
methodPattern: com.amazonaws.services.s3.AmazonS3 getBucketAcl(..)
newReturnType: software.amazon.awssdk.services.s3.model.GetBucketAclResponse
- software.amazon.awssdk.v2migration.openrewrite.ChangeMethodInvocationReturnType:
methodPattern: com.amazonaws.services.s3.AmazonS3 getObjectAcl(..)
newReturnType: software.amazon.awssdk.services.s3.model.GetObjectAclResponse
- software.amazon.awssdk.v2migration.openrewrite.ChangeMethodInvocationReturnType:
methodPattern: com.amazonaws.services.s3.AmazonS3 getBucketAccelerateConfiguration(..)
newReturnType: software.amazon.awssdk.services.s3.model.GetBucketAccelerateConfigurationResponse
- software.amazon.awssdk.v2migration.openrewrite.ChangeMethodInvocationReturnType:
methodPattern: com.amazonaws.services.s3.AmazonS3 getBucketLifecycleConfiguration(..)
newReturnType: software.amazon.awssdk.services.s3.model.GetBucketLifecycleConfigurationResponse
- software.amazon.awssdk.v2migration.openrewrite.ChangeMethodInvocationReturnType:
methodPattern: com.amazonaws.services.s3.AmazonS3 getBucketCrossOriginConfiguration(..)
newReturnType: software.amazon.awssdk.services.s3.model.GetBucketCorsResponse
- software.amazon.awssdk.v2migration.openrewrite.ChangeMethodInvocationReturnType:
methodPattern: com.amazonaws.services.s3.AmazonS3 getBucketLoggingConfiguration(..)
newReturnType: software.amazon.awssdk.services.s3.model.GetBucketLoggingResponse
- software.amazon.awssdk.v2migration.openrewrite.ChangeMethodInvocationReturnType:
methodPattern: com.amazonaws.services.s3.AmazonS3 getBucketNotificationConfiguration(..)
newReturnType: software.amazon.awssdk.services.s3.model.GetBucketNotificationConfigurationResponse
- software.amazon.awssdk.v2migration.openrewrite.ChangeMethodInvocationReturnType:
methodPattern: com.amazonaws.services.s3.AmazonS3 getBucketPolicy(..)
newReturnType: software.amazon.awssdk.services.s3.model.GetBucketPolicyResponse
- software.amazon.awssdk.v2migration.openrewrite.ChangeMethodInvocationReturnType:
methodPattern: com.amazonaws.services.s3.AmazonS3 getBucketReplicationConfiguration(..)
newReturnType: software.amazon.awssdk.services.s3.model.GetBucketReplicationResponse
- software.amazon.awssdk.v2migration.openrewrite.ChangeMethodInvocationReturnType:
methodPattern: com.amazonaws.services.s3.AmazonS3 getBucketTaggingConfiguration(..)
newReturnType: software.amazon.awssdk.services.s3.model.GetBucketTaggingResponse
- software.amazon.awssdk.v2migration.openrewrite.ChangeMethodInvocationReturnType:
methodPattern: com.amazonaws.services.s3.AmazonS3 getBucketVersioningConfiguration(..)
newReturnType: software.amazon.awssdk.services.s3.model.GetBucketVersioningResponse
- software.amazon.awssdk.v2migration.openrewrite.ChangeMethodInvocationReturnType:
methodPattern: com.amazonaws.services.s3.AmazonS3 getBucketWebsiteConfiguration(..)
newReturnType: software.amazon.awssdk.services.s3.model.GetBucketWebsiteResponse
- software.amazon.awssdk.v2migration.openrewrite.ChangeMethodInvocationReturnType:
methodPattern: com.amazonaws.services.s3.AmazonS3Client getObject(com.amazonaws.services.s3.model.GetObjectRequest, java.io.File)
newReturnType: software.amazon.awssdk.services.s3.model.GetObjectResponse
- software.amazon.awssdk.v2migration.openrewrite.ChangeMethodInvocationReturnType:
methodPattern: com.amazonaws.services.s3.AmazonS3Client getBucketAcl(..)
newReturnType: software.amazon.awssdk.services.s3.model.GetBucketAclResponse
- software.amazon.awssdk.v2migration.openrewrite.ChangeMethodInvocationReturnType:
methodPattern: com.amazonaws.services.s3.AmazonS3Client getObjectAcl(..)
newReturnType: software.amazon.awssdk.services.s3.model.GetObjectAclResponse
- software.amazon.awssdk.v2migration.openrewrite.ChangeMethodInvocationReturnType:
methodPattern: com.amazonaws.services.s3.AmazonS3Client getBucketAccelerateConfiguration(..)
newReturnType: software.amazon.awssdk.services.s3.model.GetBucketAccelerateConfigurationResponse
- software.amazon.awssdk.v2migration.openrewrite.ChangeMethodInvocationReturnType:
methodPattern: com.amazonaws.services.s3.AmazonS3Client getBucketLifecycleConfiguration(..)
newReturnType: software.amazon.awssdk.services.s3.model.GetBucketLifecycleConfigurationResponse
- software.amazon.awssdk.v2migration.openrewrite.ChangeMethodInvocationReturnType:
methodPattern: com.amazonaws.services.s3.AmazonS3Client getBucketCrossOriginConfiguration(..)
newReturnType: software.amazon.awssdk.services.s3.model.GetBucketCorsResponse
- software.amazon.awssdk.v2migration.openrewrite.ChangeMethodInvocationReturnType:
methodPattern: com.amazonaws.services.s3.AmazonS3Client getBucketLoggingConfiguration(..)
newReturnType: software.amazon.awssdk.services.s3.model.GetBucketLoggingResponse
- software.amazon.awssdk.v2migration.openrewrite.ChangeMethodInvocationReturnType:
methodPattern: com.amazonaws.services.s3.AmazonS3Client getBucketNotificationConfiguration(..)
newReturnType: software.amazon.awssdk.services.s3.model.GetBucketNotificationConfigurationResponse
- software.amazon.awssdk.v2migration.openrewrite.ChangeMethodInvocationReturnType:
methodPattern: com.amazonaws.services.s3.AmazonS3Client getBucketPolicy(..)
newReturnType: software.amazon.awssdk.services.s3.model.GetBucketPolicyResponse
- software.amazon.awssdk.v2migration.openrewrite.ChangeMethodInvocationReturnType:
methodPattern: com.amazonaws.services.s3.AmazonS3Client getBucketReplicationConfiguration(..)
newReturnType: software.amazon.awssdk.services.s3.model.GetBucketReplicationResponse
- software.amazon.awssdk.v2migration.openrewrite.ChangeMethodInvocationReturnType:
methodPattern: com.amazonaws.services.s3.AmazonS3Client getBucketTaggingConfiguration(..)
newReturnType: software.amazon.awssdk.services.s3.model.GetBucketTaggingResponse
- software.amazon.awssdk.v2migration.openrewrite.ChangeMethodInvocationReturnType:
methodPattern: com.amazonaws.services.s3.AmazonS3Client getBucketVersioningConfiguration(..)
newReturnType: software.amazon.awssdk.services.s3.model.GetBucketVersioningResponse
- software.amazon.awssdk.v2migration.openrewrite.ChangeMethodInvocationReturnType:
methodPattern: com.amazonaws.services.s3.AmazonS3Client getBucketWebsiteConfiguration(..)
newReturnType: software.amazon.awssdk.services.s3.model.GetBucketWebsiteResponse
Usage
This recipe has no required configuration options. It can be activated by adding a dependency on org.openrewrite.recipe:rewrite-third-party
in your build file or by running a shell command (in which case no build changes are needed):
- Gradle
- Gradle init script
- Maven POM
- Maven Command Line
- Moderne CLI
- Add the following to your
build.gradle
file:
plugins {
id("org.openrewrite.rewrite") version("7.5.0")
}
rewrite {
activeRecipe("software.amazon.awssdk.v2migration.S3TypesToV2")
setExportDatatables(true)
}
repositories {
mavenCentral()
}
dependencies {
rewrite("org.openrewrite.recipe:rewrite-third-party:0.20.0")
}
- Run
gradle rewriteRun
to run the recipe.
- Create a file named
init.gradle
in the root of your project.
initscript {
repositories {
maven { url "https://plugins.gradle.org/m2" }
}
dependencies { classpath("org.openrewrite:plugin:7.5.0") }
}
rootProject {
plugins.apply(org.openrewrite.gradle.RewritePlugin)
dependencies {
rewrite("org.openrewrite.recipe:rewrite-third-party:0.20.0")
}
rewrite {
activeRecipe("software.amazon.awssdk.v2migration.S3TypesToV2")
setExportDatatables(true)
}
afterEvaluate {
if (repositories.isEmpty()) {
repositories {
mavenCentral()
}
}
}
}
- Run the recipe.
gradle --init-script init.gradle rewriteRun
- Add the following to your
pom.xml
file:
<project>
<build>
<plugins>
<plugin>
<groupId>org.openrewrite.maven</groupId>
<artifactId>rewrite-maven-plugin</artifactId>
<version>6.7.0</version>
<configuration>
<exportDatatables>true</exportDatatables>
<activeRecipes>
<recipe>software.amazon.awssdk.v2migration.S3TypesToV2</recipe>
</activeRecipes>
</configuration>
<dependencies>
<dependency>
<groupId>org.openrewrite.recipe</groupId>
<artifactId>rewrite-third-party</artifactId>
<version>0.20.0</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</build>
</project>
- Run
mvn rewrite:run
to run the recipe.
You will need to have Maven installed on your machine before you can run the following command.
mvn -U org.openrewrite.maven:rewrite-maven-plugin:run -Drewrite.recipeArtifactCoordinates=org.openrewrite.recipe:rewrite-third-party:RELEASE -Drewrite.activeRecipes=software.amazon.awssdk.v2migration.S3TypesToV2 -Drewrite.exportDatatables=true
You will need to have configured the Moderne CLI on your machine before you can run the following command.
mod run . --recipe S3TypesToV2
If the recipe is not available locally, then you can install it using:
mod config recipes jar install org.openrewrite.recipe:rewrite-third-party:0.20.0
See how this recipe works across multiple open-source repositories
Run this recipe on OSS repos at scale with the Moderne SaaS.

The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.
Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.
Data Tables
- SourcesFileResults
- SourcesFileErrors
- RecipeRunStats
Source files that had results
org.openrewrite.table.SourcesFileResults
Source files that were modified by the recipe run.
Column Name | Description |
---|---|
Source path before the run | The source path of the file before the run. null when a source file was created during the run. |
Source path after the run | A recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run. |
Parent of the recipe that made changes | In a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all. |
Recipe that made changes | The specific recipe that made a change. |
Estimated time saving | An estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds. |
Cycle | The recipe cycle in which the change was made. |
Source files that errored on a recipe
org.openrewrite.table.SourcesFileErrors
The details of all errors produced by a recipe run.
Column Name | Description |
---|---|
Source path | The file that failed to parse. |
Recipe that made changes | The specific recipe that made a change. |
Stack trace | The stack trace of the failure. |
Recipe performance
org.openrewrite.table.RecipeRunStats
Statistics used in analyzing the performance of recipes.
Column Name | Description |
---|---|
The recipe | The recipe whose stats are being measured both individually and cumulatively. |
Source file count | The number of source files the recipe ran over. |
Source file changed count | The number of source files which were changed in the recipe run. Includes files created, deleted, and edited. |
Cumulative scanning time | The total time spent across the scanning phase of this recipe. |
99th percentile scanning time | 99 out of 100 scans completed in this amount of time. |
Max scanning time | The max time scanning any one source file. |
Cumulative edit time | The total time spent across the editing phase of this recipe. |
99th percentile edit time | 99 out of 100 edits completed in this amount of time. |
Max edit time | The max time editing any one source file. |