aws-doc-sdk-examples 仓库完全指南：多语言 AWS SDK 示例的组织、运行与贡献

示例工程教程后端【免费下载链接】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 Code Examples Repository仓库根目录 README.md展开系统讲解这个为 AWS 官方文档与各语言 SDK 开发者指南提供代码示例的开源仓库从顶层目录结构与 SDK 版本对照到示例代码的调用前提、运行方式、测试体系再到贡献与示例请求的流程规范。读完本文你将能够快速定位任意语言、任意 AWS 服务的示例代码掌握在多语言目录中运行与测试示例的通用方法并理解该仓库的质量保障机制与许可边界。仓库定位面向 AWS 文档与开发者的代码示例集根目录 README.md 开宗明义地指出这个仓库包含用于演示如何通过 AWS SDK 与 AWS 服务交互的代码示例其中大量示例被直接注入到 AWS 官方文档中。这意味着仓库中的代码并非孤立的教学片段而是 AWS Documentation、AWS SDK Developer Guides 等官方内容背后的活素材。从实际仓库结构看这一定位体现在两方面覆盖面广从 C 到 Swift从经典的 SDK v1 到 v3/v4仓库覆盖了 .NET、C、Go、Java、JavaScript、Kotlin、PHP、Python、Ruby、Rust、Swift 等多语言生态还包含sap-abap/、aws-cli/、aws-cfn/等非传统 SDK 的示例。与文档联动多数示例遵循单服务动作action— 单服务场景scenario— 跨服务示例cross-service的层级组织这种结构正是为了便于 AWS 文档按场景引用。仓库组织结构按语言 SDK 与版本分区README 用一张清晰的对照表定义了各语言子目录与 SDK 版本的对应关系这是导航整个仓库的第一把钥匙SDK目录SDK 版本.NETdotnetv3/3.5.NET.dotnet/3.5Ccpp/1Gogov2/2Gogo/1Javajavav2/2Javajava/1JavaScriptjavascriptv3/3JavaScriptjavascript/2Kotlinkotlin/1PHPphp/3Pythonpythonv1/1Pythonpython/3Rubyruby/3Rustrustv1/1Swiftswift/preview需要留意两个容易混淆的点同名语言、不同版本并存例如 Go 同时存在 go/v1 SDK与 gov2/v2 SDKPython 同时存在 pythonv1/v1 SDK与 python/v3 SDK即 Boto3。选错目录会导致 API 调用方式与示例不匹配。JavaScript 目录命名README 表格中javascript/一栏的目录链接实际指向 javascriptv3/v2 SDK 示例而 v3 SDK 的示例在 javascriptv3/。选择前请先确认你使用的 SDK 大版本。README 同时给出了一条重要的维护状态提示NOTE按照 AWS 的 SDKs and Tools Maintenance PolicyAWS SDK for Java v1.x 已于 2024 年 7 月 31 日进入维护模式并将在 2025 年 12 月 31 日停止支持。因此 java/ 目录下的 v1 示例更适合作为迁移参考新项目应优先使用 javav2/。每个语言目录内部都带有SDK 专属的说明用于指导理解与调用对应示例。以 python/README.md 为典型代表它进一步细化了示例的组织方式单服务动作Single-service actions演示如何调用单个服务函数按服务存放在 python/example_code 目录每个服务子目录的 README 说明运行方式单服务场景Single-service scenarios在同一服务内通过多次函数调用完成某个具体任务跨服务示例Cross-service examples跨多个 AWS 服务协同工作的示例应用集中在 python/cross_service 目录。这种动作 — 场景 — 跨服务的三层分类在多数语言目录如 dotnetv3/、kotlin/、javascriptv3/中都能看到对应的目录形态是整个仓库共用的组织范式。附加目录生产级应用、共享资源与测试框架除语言目录外README 还说明了三个跨语言共享的附加目录目录用途使用方式applications/存放与语言无关的生产级示例应用组件展示 SDK 在生产式应用中的用法各应用的语言侧实现见对应语言子目录下的cross-service目录.tools/原 README 所述 test 目录支撑仓库例行测试的自定义测试自动化框架组件以容器化的多语言集成测试方案部署到 AWS目前仍在持续建设中resources/供仓库内大量示例共享的公共组件以前端resources/clients或后端resources/cdk、resources/cfn组件形式部署生产级应用示例applicationsapplications/README.md 给出了两个完整的、跨语言的生产级示例应用名称路径支持语言重点服务Photo Asset Managerapplications/photo-asset-managerC、.NET、Java、JavaScript、RustAmazon Rekognition、Amazon API Gateway、Amazon CloudFront、Amazon Cognito、Amazon S3Feedback Sentiment Analyzerapplications/feedback_sentiment_analyzerRuby、JavaScriptAmazon Textract、Amazon Comprehend、Amazon Translate、Amazon Polly、AWS Step Functions每个应用遵循统一的内容约定便于扩展与复刻AWS CloudFormationCFN与 AWS Cloud Development KitCDK提供自动/半自动的资源创建脚手架每个示例至少有一个功能用多种语言实现多数带有前端组件并配套四份文档——README.md部署与使用概览、SPECIFICATION.md架构与业务逻辑、DEVELOPMENT.md如何用另一种语言扩展该应用、README_TEMPLATE.md语言侧 README 的模板以及DESIGN.md开发决策记录。例如 applications/photo-asset-manager 与 applications/feedback_sentiment_analyzer 根目录下均完整携带这些文件。共享资源目录resourcesresources/ 是支撑大量示例的公共资产库从当前仓库结构看可细分为resources/cdk面向具体示例的 CDK 堆栈集合覆盖 DynamoDB 数据表、Lambda API Gateway、S3 事件通知、SQS SSE-KMS 加密、Textract 视频分析、Rekognition 无认证角色、Step Functions 演示等约三十个场景例如cognito_scenario_user_pool_with_mfa/、lambda_using_api_gateway/、textract_example_s3_sns_sqs/resources/cfnCloudFormation 模板集合目前包含entity-resolution-basics/、iotsitewise_basics/、s3_express_basics/等基础场景resources/clients前端组件如 resources/clients/reactresources/sample_files示例代码运行所需的样例文件。测试与工程化基础设施README 提及的自定义测试自动化框架在仓库中对应 .tools/ 目录内含测试栈.tools/test、Docker 镜像.tools/docker-images、校验工具.tools/validation、脚本与代码片段等。此外多数语言目录自带测试工具链例如 python/test_tools 提供了统一的测试运行入口见下文测试体系一节。运行示例代码的前提条件README 明确指出要调用这些示例代码必须满足两个前提拥有 AWS 账户示例会真实创建、修改乃至删除 AWS 资源需要可用的账户环境配置 AWS 凭据需要完成 AWS CLI 的配置基础流程configure credentials通常即配置aws_access_key_id、aws_secret_access_key与默认区域写入本地凭据文件。以 python/README.md 为例具体的前置条件还包括Python 3.6.0 或更高版本以及按 AWS Tools and SDKs Shared Configuration and Credentials Reference 配置好的默认凭据与区域。通用运行流程以 Python 为例绝大多数 Python 示例目录都带有requirements.txt标准流程如下进入示例目录并创建虚拟环境python -m venv .venv激活虚拟环境按操作系统选择.venv\Scripts\activate # Windows source .venv/bin/activate # Linux, macOS, or Unix安装依赖python -m pip install -r requirements.txt运行示例。多数示例含__main__入口可直接执行python file_with_main.py需要命令行参数的示例可先运行python file_with_main.py -h查看帮助每个示例目录的 README 还会给出更具体的运行说明与其他前置条件。测试体系单元测试与集成测试分离仓库的测试策略是单元测试零成本、集成测试真上云。单元测试以 Python 为例单元测试使用 botocore Stubber 打桩返回 mock 响应请求不会真正发送到 AWS因此运行单元测试不会产生费用。在各示例目录下通过排除integ标记运行python -m pytest -m not integ集成测试集成测试会向 AWS 发送真实请求可能创建与销毁账户内资源并产生费用。运行方式为显式指定integ标记python -m pytest -m integ仓库还提供了批量化运行测试的入口例如 python/test_tools/run_all_tests.py 可在一个 Docker 容器内运行全部单元测试也支持通过-m integ标志执行集成测试。在多语言仓库层面cpp/run_automated_tests.py、.tools/test 等共同构成了容器化的多语言集成测试体系。Docker 化运行方式Python 语言目录提供预构建的容器镜像镜像内预装了全部 Python 示例并解析好依赖便于在隔离环境中探索。构建与启动命令为docker build -t image_name . # 在 python/ 目录下执行 docker run -it -v ~/.aws/credentials:/root/.aws/credentials image_name容器启动后进入 bash示例代码位于容器内的python目录。其他语言目录如 cpp/Dockerfile、javascriptv3/Dockerfile、rustv1/Dockerfile同样提供了 Dockerfile印证了仓库容器化交付示例的统一思路。场景目录基础场景与功能场景的沉淀除按语言组织的示例外仓库还提供了跨语言、面向业务场景的沉淀目录 scenarios/scenarios/basics基础能力场景涵盖 Amazon S3、S3 Express、Redshift、OpenSearch、GuardDuty、Batch、Control Tower、ECR、IoT、KMS、Location、Neptune、SSM、SiteWise、Inspector、Entity Resolution 等服务的入门用例scenarios/features进阶功能场景例如 Bedrock Converse Tool、EventBridge Scheduler、Firehose、Resilient Service、S3 Conditional Requests、S3 Object Lock、SageMaker Pipelines、SESv2 邮件、SNS/SQS 主题与队列、User Pools 与 Lambda 触发器、CloudWatch Logs 大查询等。这些场景文档每个以.md呈现通常描述跨语言的能力说明 各语言实现路径是阅读各语言示例前快速理解业务目标的最佳入口。例如 scenarios/features/topics_and_queues 与各语言目录下的topics_and_queues交叉服务示例相互呼应。使用免责声明与成本提醒README 以醒目的方式给出了两条使用警示属于必读的合规信息费用风险这些代码示例会与 AWS 服务交互可能对你的账户产生费用需参考 AWS Pricing 评估成本资源风险示例代码理论上可能修改或删除现有的 AWS 资源。作为尽职调查请务必做到清楚了解这些示例会创建或删除哪些资源了解由此可能产生的账户费用备份重要数据。python/README.md 还补充了权限最佳实践建议按最小权限原则least privilege授权只授予完成任务所需的最低权限并提醒示例并非在每个 AWS 区域都经过测试。在开发环境或正式账户中运行示例前务必阅读对应目录的 README 与场景文档确认其资源清单。贡献与示例请求流程仓库欢迎社区贡献README 与 CONTRIBUTING.md 共同定义了参与方式贡献代码通过 Pull Request 提交贡献者应先阅读 CONTRIBUTING.md 与行为准则仓库根目录 CODE_OF_CONDUCT.md请求示例通过 Issue tracker 提交 enhancement 类型的请求。团队会从三个维度评估所有请求——清晰度Clarity、相关性Relevance、可行性Feasibility据此确定优先级并分配资源清晰、相关且能在合理时间内完成的请求优先附带高质量 PR 会显著提高请求被受理的概率时间要求所有示例请求应尽早提出对于较大的示例至少应在需求日期前两个月提交优先级说明Bug 修复与安全问题等请求优先于新示例的开发团队自身有限资源与内部优先级也会影响排期。多语言贡献时需遵循各语言的工程规范例如 Python 代码使用 pylint并通过 CI如 .github/workflows 下的 lint 工作流对变更文件自动执行检查。上游来源Tributaries机制README 用一个形象的比喻解释了 AWS 文档中代码示例的来源除本仓库外还有若干支流汇入 AWS 文档这条大河包括本仓库awsdocs/aws-doc-sdk-examples、serverless-snippetsAWS Samples 组织以及 AWS Tools for PowerShell 等。这意味着在 AWS 官方文档中看到的代码可能来自多个上游仓库本仓库是其中最主要的一个。查找示例时如果在本仓库未找到某段文档代码可以留意它是否来自上述其他上游来源。版权与许可证除非另有说明仓库内所有内容版权归 Amazon Web Services, Inc. 及其关联公司所有。除特别注明外所有示例依据 Apache License 2.0 授权完整文本见仓库根目录 LICENSE 文件。许可证要求在所有可能的文件顶部包含如下许可文本Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0这一要求与各语言目录 README 末尾的版权声明例如 python/README.md 末行完全一致贡献者在提交新代码时需保持该头注释。结语从导航到实践概括而言在 aws-doc-sdk-examples 仓库中高效工作只需三步先依据 README 的 SDK 版本对照表 定位正确的语言目录与版本再通过目录内 README 与 scenarios/ 场景文档找到目标示例及其运行说明最后按各语言标准流程虚拟环境、依赖安装、pytest/Docker 测试运行与验证。无论是学习 AWS SDK 用法、为文档提供示例还是基于 applications/ 中的生产级应用做二次开发这个仓库都是最直接的起点。赞分享示例工程教程后端【免费下载链接】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点击查看免费下载相关推荐3个步骤修复ROG游戏本色彩配置文件丢失G-Helper实用指南3个步骤修复ROG游戏本色彩配置文件丢失G Helper实用指南 当你发现ROG游戏本的屏幕色彩突然变得灰白、饱和度降低或对比度异常时很可能遇到了色彩配置文桌面应用系统编程AWS CLI 示例实战指南aws-doc-sdk-examples 仓库中 AWS CLI 代码示例的安装、运行与测试全解析AWS CLI 示例实战指南aws doc sdk examples 仓库中 AWS CLI 代码示例的安装、运行与测试全解析 本指南以 aws cli/RE示例工程教程后端aws-doc-sdk-examples 多语言 SDK 示例 Docker 镜像构建、拉取与在 AgentSpaces 中运行测试的完整指南aws doc sdk examples 多语言 SDK 示例 Docker 镜像构建、拉取与在 AgentSpaces 中运行测试的完整指南 aws doc示例工程教程后端上一篇10分钟上手Unity逆向Il2CppDumper与VS Code轻量级开发指南下一篇RestSharp高并发处理每秒千次请求的优化方案创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考