示例工程教程后端【免费下载链接】aws-doc-sdk-examplesWelcome to the AWS Code Examples Repository. This repo contains code examples used in the AWS documentation, AWS SDK Developer Guides, and more. For more information, see the Readme.md file below.项目地址https://gitcode.com/gh_mirrors/aw/aws-doc-sdk-examples点击查看免费下载本文基于javav2/example_code/quicksight/README.md的完整内容展开结合该目录下的 Maven 工程、JUnit 集成测试与 9 个 QuickSight 操作示例类讲清楚如何配置环境、准备 QuickSight 资源参数、运行各示例、以及用mvn test驱动集成测试并解读成功/失败输出。读完本文你可以独立在当前仓库中编译并运行 Amazon QuickSight 的 Java 2.x 代码示例理解DescribeAnalysis、UpdateDashboard等操作的底层 SDK 调用链并掌握测试失败时的排查方法。示例总览目录结构与文件清单QuickSight 示例位于javav2/example_code/quicksight/目录采用标准 Maven 项目布局。该目录的 README 负责说明运行与测试流程配套的 metadata.yaml 则登记了每个源文件及其关联的 AWS 服务均为quicksight供仓库的文档/测试工具链识别src/main/java/com/example/quicksight/下共 9 个示例类DescribeAnalysis.javaDescribeDashboard.javaDescribeTemplate.javaListAnalyses.javaListDashboards.javaListDataSets.javaListTemplates.javaListThemes.javaUpdateDashboard.javasrc/test/java/下为集成测试类 QuickSightTest.java构建文件为 pom.xml每个示例类都遵循统一模式main方法解析命令行参数并打印 usage 说明再调用一个静态方法执行真实的 QuickSight API 操作。这样既支持独立从命令行运行也可以被 JUnit 测试直接复用同一批静态方法。构建环境Maven 工程与 SDK 依赖README 指出的前提是通过 Apache Maven 或 Gradle 搭建 AWS SDK for Java 项目的开发环境。本示例采用的是 Maven 工程pom.xml 中的关键配置如下配置项取值说明java.version/maven.compiler.source/maven.compiler.target21编译与运行需要 JDK 21software.amazon.awssdk:bom2.35.10dependencyManagement 导入统一管理 AWS SDK 2.x 各模块版本org.apache.logging.log4j:log4j-bom2.23.1dependencyManagement 导入日志实现版本管理org.junit.jupiter:junit-jupiter5.11.4test scopeREADME 所述 JUnit 5 测试框架maven-surefire-plugin3.5.2执行 JUnit 测试的 Maven 插件software.amazon.awssdk:quicksightBOM 管理QuickSight 客户端核心依赖software.amazon.awssdk:secretsmanagerBOM 管理测试类用于读取测试参数见下文software.amazon.awssdk:s3、sso、ssooidcBOM 管理SDK 身份/服务相关辅助依赖com.google.code.gson:gson2.10.1测试中解析 JSON 格式的密文值从源码结构看所有示例客户端都通过QuickSightClient.builder().region(Region.US_EAST_1).build()构建区域被硬编码为us-east-1。如果你的 QuickSight 资源不在该区域需要自行调整Region取值后运行。运行示例前准备 QuickSight 资源与参数README 明确要求在运行测试前先在 AWS 中创建对应的 QuickSight 资源按官方 “Getting Started with Data Analysis in Amazon QuickSight” 流程创建数据集、分析、仪表板、模板等。README 列出的 6 个必需参数如下account— AWS 账号 IDanalysisId— 已有 Analysis 的 ARNREADME 原文表述dashboardId— QuickSight 仪表板 IDtemplateId— QuickSight 模板 IDdataSetArn— 数据集的 ARNanalysisArn— 已有 Analysis 的 ARN。README 说明这些值需定义在resources文件夹的config.properties文件中若缺少任一值JUnit 测试会失败。需要注意的一处版本演进当前仓库中的 QuickSightTest.java 实际上是从AWS Secrets Manager读取这 6 个值而不是直接读取 properties 文件。测试的setUp方法BeforeAll构建SecretsManagerClient同样固定us-east-1区域调用getSecretValue读取名为test/quicksight的 Secret返回的 JSON 字符串经 Gson 反序列化为内部类SecretValues随后填充account、analysisId、dashboardId、templateId、dataSetArn、analysisArn六个静态字段见 QuickSightTest.java 第 33–49 行 与 第 116–128 行。因此在当前仓库状态下你需要在 Secrets Manager 中准备test/quicksight这条 Secret其值为包含上述 6 个键的 JSONREADME 中 config.properties 的描述可视为早期/等价的配置方式二者提供的参数集合完全一致。九个示例与 QuickSight API 对照下表汇总了src/main/java/com/example/quicksight/下每个示例类所封装的 SDK 操作、命令行用法取自各类的 usage 说明与关键输出示例类调用的 QuickSight API命令行参数打印结果DescribeAnalysis.javadescribeAnalysisaccount analysisIdAnalysis 的 ARN、名称、主题 ARN、数据集 ARN 列表DescribeDashboard.javadescribeDashboardaccount dashboardId仪表板显示名称DescribeTemplate.javadescribeTemplateaccount templateId模板 ARNListAnalyses.javalistAnalysesmaxResults20account每个 Analysis 的名称、状态、IDListDashboards.javalistDashboardsmaxResults20account每个仪表板的名称、ARN、IDListDataSets.javalistDataSetsmaxResults20account每个数据集的名称、ARNListTemplates.javalistTemplatesmaxResults20account每个模板的 ARN、ID、名称ListThemes.javalistThemesaccount每个主题的 ID、名称、ARN、最新版本号UpdateDashboard.javacreateTemplateupdateDashboardaccount dashboardId dataSetArn analysisArn“Dashboard xxx has been updated”所有示例的错误处理保持一致捕获QuickSightException通过e.awsErrorDetails().errorMessage()打印 AWS 侧错误信息并以退出码 1 结束进程。代码走读Describe 与 List 类示例的共同骨架以 DescribeAnalysis.java 为例核心逻辑是public static void describeSpecificAnalysis(QuickSightClient qsClient, String account, String analysisId) { try { DescribeAnalysisRequest analysisRequest DescribeAnalysisRequest.builder() .awsAccountId(account) .analysisId(analysisId) .build(); DescribeAnalysisResponse analysisResponse qsClient.describeAnalysis(analysisRequest); System.out.println(The Analysis ARN value is analysisResponse.analysis().arn()); System.out.println(The Analysis ARN name is analysisResponse.analysis().name()); System.out.println(The Analysis theme ARN value is analysisResponse.analysis().themeArn()); System.out.println(The Analysis dataSet ARN is analysisResponse.analysis().dataSetArns()); } catch (QuickSightException e) { System.err.println(e.awsErrorDetails().errorMessage()); System.exit(1); } }要点awsAccountId是几乎所有 QuickSight API 请求的必填字段——QuickSight 的多租户模型要求每个请求显式指明资源所属账号这也是 6 个测试参数中account排在首位的原因。List 类示例都设置了maxResults(20)作为单页上限响应中以analysisSummaryList()、dashboardSummaryList()、dataSetSummaries()、templateSummaryList()、themeSummaryList()等访问器取出摘要列表后逐条打印从源码结构看这些示例未处理分页 token属于“取一页”级别的演示。main方法在调用前校验参数个数例如DescribeAnalysis要求恰好 2 个参数ListThemes要求 1 个不满足时打印 usage 文本并退出这使每个类都可以当作独立的命令行工具使用。深入 UpdateDashboard从 Analysis 到模板再到仪表板的更新链UpdateDashboard.java 是九例中最复杂的示例它演示了 QuickSight 资源间的派生关系Analysis →CreateTemplate→ Template →UpdateDashboard→ Dashboard。其调用链分为两步第一步基于已有 Analysis 创建模板getTemplateARN私有方法见 第 104–139 行DataSetReference setReference DataSetReference.builder() .dataSetArn(dataset) .dataSetPlaceholder(Dataset placeholder2) .build(); TemplateSourceAnalysis templateSourceAnalysis TemplateSourceAnalysis.builder() .dataSetReferences(setReference) .arn(analysisArn) .build(); TemplateSourceEntity sourceEntity TemplateSourceEntity.builder() .sourceAnalysis(templateSourceAnalysis) .build(); UUID uuid UUID.randomUUID(); String templateGUID uuid.toString(); CreateTemplateRequest createTemplateRequest CreateTemplateRequest.builder() .awsAccountId(account) .name(NewTemplate) .sourceEntity(sourceEntity) .templateId(templateGUID) // Specify a GUID value .build(); CreateTemplateResponse response qsClient.createTemplate(createTemplateRequest); arn response.arn();这里有两个值得注意的实现细节模板 ID 用UUID.randomUUID()生成以保证每次运行创建全新模板避免与已有模板冲突DataSetReference中的dataSetPlaceholder(Dataset placeholder2)将模板中的占位符名称映射到真实数据集 ARN——这是 QuickSight 模板机制的核心允许同一模板在不同环境中替换数据集。第二步用模板更新指定仪表板updateSpecificDashboard见 第 68–102 行DashboardSourceTemplate sourceTemplate DashboardSourceTemplate.builder() .dataSetReferences(dataSetReference) .arn(arn) .build(); DashboardSourceEntity sourceEntity DashboardSourceEntity.builder() .sourceTemplate(sourceTemplate) .build(); UpdateDashboardRequest dashboardRequest UpdateDashboardRequest.builder() .awsAccountId(account) .dashboardId(dashboardId) .name(UpdateTest) .sourceEntity(sourceEntity) .themeArn(arn:aws:quicksight::aws:theme/MIDNIGHT) .build(); UpdateDashboardResponse response qsClient.updateDashboard(dashboardRequest);请求中name(UpdateTest)会替换仪表板显示名称themeArn指向 AWS 内置的 MIDNIGHT 主题。该示例会真实修改目标仪表板因此 README 的警告在此体现得最充分运行它会操作真实的 AWS 资源可能产生费用。测试QuickSightTest 的结构与执行QuickSightTest.java 用 JUnit 5 以集成测试的形式覆盖了 8 个示例方法DescribeAnalysis、DescribeDashboard、DescribeTemplate、ListThemes、ListAnalyses、ListDashboards、ListTemplates、UpdateDashboard对应关系为TestInstance(TestInstance.Lifecycle.PER_METHOD) TestMethodOrder(MethodOrderer.OrderAnnotation.class) public class QuickSightTest { ... Test Tag(IntegrationTest) Order(1) public void testDescribeAnalysis() { assertDoesNotThrow(() - DescribeAnalysis.describeSpecificAnalysis(qsClient, account, analysisId)); logger.info(Test 1 passed); } // Test 2 ... Test 8 依次覆盖其余示例UpdateDashboard 为 Order(8) }结构设计要点TestMethodOrder(MethodOrderer.OrderAnnotation.class)Order(1)至Order(8)保证测试按编号顺序执行使测试输出中的 “Test N passed” 编号稳定可预期断言统一使用assertDoesNotThrow即“只要 SDK 调用不抛出异常即视为通过”符合这类对真实 AWS 资源的集成测试定位所有测试打上Tag(IntegrationTest)标签便于在 CI 中按需分组筛选执行每个测试方法执行成功后用 SLF4J 记录Test N passed例如 README 中提到的 “Test 3 passed” 消息即来自testDescribeTemplate中的logger.info(Test 3 passed)见 第 67–73 行。命令行运行测试与结果解读从命令行执行按 README 的说明在示例目录下执行mvn test也可以在 IntelliJ 等 IDE 中直接运行QuickSightTest。README 给出了成功时的典型输出节选[INFO] ------------------------------------------------------- [INFO] T E S T S [INFO] ------------------------------------------------------- [INFO] Running QuickSightTest Test 1 passed Test 2 passed ... Done! [INFO] Results: [INFO] [INFO] Tests run: 9, Failures: 0, Errors: 0, Skipped: 0 [INFO] [INFO] BUILD SUCCESS需要说明的是README 示例输出中的 “Tests run: 9” 来自文档写作时的测试版本当前仓库的 QuickSightTest.java 定义了 8 个带Order的测试方法实际运行结果以当前源码为准应为 8 个测试。测试失败的排查README 指出若参数文件中未定义正确的值JUnit 测试不会成功Maven 会报告BUILD FAILURE例如[INFO] BUILD FAILURE [ERROR] Failed to execute goal org.apache.maven.plugins:maven-surefire-plugin:2.22.1:test (default-test) on project ... There are test failures.当前 pom.xml 中 surefire 版本已更新为 3.5.2报错信息中显示的插件版本号以实际构建为准。排查步骤与 README 一致核对参数值当前源码为 Secrets Manager 中test/quicksight的 JSON 内容是否齐全且指向真实存在的资源——account是否为 12 位账号 ID、analysisId/analysisArn是否为真实 Analysis 的 ARN、dashboardId/templateId是否与 QuickSight 控制台中的 ID 一致、dataSetArn是否为有效数据集 ARN——修正后重新运行mvn test。由于测试直接对真实 AWS 账号执行describe*、list*乃至updateDashboard操作除费用外还要注意UpdateDashboard会改动目标仪表板的名称与主题。小结javav2/example_code/quicksight/目录以一套 Maven 工程 JUnit 5 集成测试的形态演示了 AWS SDK for Java 2.x 调用 QuickSight 服务的完整闭环参数准备6 个资源标识、读取类操作Describe/List 五类资源、以及依赖链操作Analysis → Template → Dashboard。运行前请确认 JDK 21 环境、AWS 凭据配置、资源位于us-east-1区域源码硬编码并按当前源码从 Secrets Manager 提供test/quicksight参数值理解awsAccountId必填、模板占位符替换数据集、以及集成测试“以不抛异常为通过标准”这三个要点即可顺畅运行并扩展这套示例。赞分享示例工程教程后端【免费下载链接】aws-doc-sdk-examplesWelcome to the AWS Code Examples Repository. This repo contains code examples used in the AWS documentation, AWS SDK Developer Guides, and more. For more information, see the Readme.md file below.项目地址https://gitcode.com/gh_mirrors/aw/aws-doc-sdk-examples点击查看免费下载相关推荐AWS SDK for Java 2.x 实战在 aws-doc-sdk-examples 中运行与测试 Amazon MQ 的 Java 示例AWS SDK for Java 2.x 实战在 aws doc sdk examples 中运行与测试 Amazon MQ 的 Java 示例 本文基于 j示例工程教程后端AWS SDK for Java 2.x 操作 Amazon Pinpoint 实战aws-doc-sdk-examples 中的 Pinpoint 代码示例详解AWS SDK for Java 2.x 操作 Amazon Pinpoint 实战aws doc sdk examples 中的 Pinpoint 代码示例示例工程教程后端AWS CLI 示例实战指南aws-doc-sdk-examples 仓库中 AWS CLI 代码示例的安装、运行与测试全解析AWS CLI 示例实战指南aws doc sdk examples 仓库中 AWS CLI 代码示例的安装、运行与测试全解析 本指南以 aws cli/RE示例工程教程后端上一篇Flapigen Android开发完整解决方案从JNI到APK打包终极指南下一篇想在Godot里做银河恶魔城这个插件把最难的地图与存档全包了创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考