--- name: service-dossier-a196e4e064ac description: Generate a new AWS service dossier under .agents/docs/services or enhance an existing service dossier with Smithy-derived operation/resource facts, official AWS documentation research, concrete usage scenarios, and durable Winterbaume LTM lessons. argument-hint: user_invocable: true --- # Service Dossier Create or enhance `.agents/docs/services/.md` so future Winterbaume work starts from accurate service context. ## Inputs - `$0` - service name, Winterbaume crate suffix, AWS SDK slug, or Smithy model slug. ## Core Rules - Treat `vendor/api-models-aws` as the source of truth for service identity, protocol, operations, required input members, HTTP-bound input members (`@httpHeader`, `@httpQuery`, `@httpPrefixHeaders`, `@httpPayload`, `@httpLabel`), idempotency, pagination, error shapes (including empty-member shapes, which signal "no response body" for HEAD operations), and Smithy resources. - Treat official AWS documentation as the source of truth for semantics not present in Smithy: lifecycle transitions, cross-resource constraints, defaults, quotas, deletion prerequisites, policy behaviour, synchronisation, workflow ordering, RFC 7232 conditional-write semantics (412 PreconditionFailed, 409 ConditionalRequestConflict), HTTP-method body rules (HEAD/GET differences, redirect handling), and any HTTP error codes the service emits that are absent from the modelled `errors:` list. - Read `.agents/docs/LTM/aws-doc-test-plan-catalog.md` and `.agents/docs/LTM/workspace-readmes-and-service-examples.md` before changing scenarios. Scenario bullets are planning prompts, not implementation guarantees. - For repo-authored docs, use British English and half-width punctuation only. - Preserve any `Winterbaume LTM Notes`, `Cross-call invariants`, service-specific TODOs, or hand-written parity notes already present in an existing dossier unless the user explicitly asks to rewrite them. ## Workflow ### 1. Resolve the Service 1. Read `.agents/docs/services/INDEX.md`. 2. If the service is listed, use that row's model slug and read `.agents/docs/services/.md`. 3. If the service is missing, find the Smithy model under `vendor/api-models-aws/models//service//*.json`. 4. If multiple matches exist, disambiguate by title, SDK ID, endpoint prefix, and AWS SDK slug. Do not guess between similarly named control/data plane services. Useful local commands: ```bash grep -R -n -E "\\[\\]|``|" .agents/docs/services/INDEX.md vendor/api-models-aws/gradle.properties vendor/api-models-aws/models find vendor/api-models-aws/models//service -name '*.json' ``` ### 2. Extract Smithy Facts Run the bundled extractor to produce a draft or comparison aid: ```bash python3 .agents/skills/service-dossier/scripts/extract_model_dossier.py ``` The extractor is read-only. When `.agents/docs/services/.md` already exists, it detects that file and prints an `Existing Dossier Notes` section listing merge-sensitive top-level sections. It does not merge or rewrite the dossier for you. Use its output to populate or verify: - Service identity and protocol. - Operation family counts. - Operation groups. - Operation detail matrix. - `HTTP Bindings` section: per-operation `@httpHeader` / `@httpQuery` / `@httpPrefixHeaders` / `@httpPayload` input members. The extractor also emits a "Conditional-write/read coverage" summary listing every operation whose input includes RFC 7232 headers — this is the canonical list of operations that must enforce 412 PreconditionFailed (and possibly 409 ConditionalRequestConflict) and must surface those error codes in tests. - **Opaque binary payloads (`@httpPayload` blobs).** For every `@httpPayload` member, resolve its target shape kind. A member whose target is a **blob** is the raw, opaque HTTP body: codegen renders it as `bytes::Bytes` and the deserialiser stores `request.body.clone()` with **no** `std::str::from_utf8` / XML / base64 decoding — UTF-8-validating it `400`s any binary body (issue #12). The dossier must add an "Opaque binary payloads" subsection under Behavioural Model Notes that lists each blob-payload operation and its **true content contract**, because "it's a blob" does not mean the service accepts arbitrary binary. Classify each: *genuinely arbitrary binary* (object stores like S3 / Glacier / MediaStore data, and invoke/publish payloads like Lambda / SageMaker Runtime / IoT `Publish`) vs *format-constrained* (real AWS parses/validates and rejects binary — e.g. API Gateway `Import*` = OpenAPI/CSV, CloudSearch `UploadDocuments` = SDF JSON/XML, IoT `UpdateThingShadow` = JSON, AppConfig feature-flag / JSON-Schema profiles = JSON). Research the required format from AWS docs and note that winterbaume's stub is more permissive than AWS wherever it does not enforce that format. Non-payload blobs stay `String` (base64 on the wire) — do not conflate them. - Important error, input, output, enum, and resource-related shapes. Pay attention to error shapes rendered with `**empty (no members)**`: that empty member set encodes "the HTTP response carries no body," which is critical for HEAD operations (a body forces the SDK into Unhandled instead of resolving the typed `NotFound` variant). - Resource model, when Smithy declares resources. If the model has no Smithy resources, derive conceptual resources from AWS docs and operation names, and say that the Smithy model lacks `resource` shapes. ### 3. Research Official AWS Documentation Use the AWS Documentation MCP Server. Prefer official service user-guide and API-reference pages. Search for: - ` overview concepts` - ` API Reference ` - ` create delete update list
` - ` quotas limits lifecycle access point policy tags pagination` - ` conditional requests preconditions 412` (when the extractor's HTTP Bindings section lists any `If-Match` / `If-None-Match` / `If-Modified-Since` / `If-Unmodified-Since` / `x-amz-copy-source-if-*` headers — otherwise skip). - ` HEAD response body` (when the operation matrix lists any `HEAD` method — otherwise skip). - ` error codes responses` (look for HTTP error codes not represented in any operation's modelled `errors:` list — these are documented behaviour without a typed error shape). Read only pages that answer concrete parity questions. Record URLs in `Official AWS Documentation Research`. Look specifically for: - Main resources and their identifiers. - Required creation order and deletion prerequisites. - Lifecycle states and asynchronous job behaviour. - Idempotency and duplicate-create behaviour beyond Smithy traits. - Cross-resource constraints and reverse references. - Account/service defaults that affect later creates. - Policy, IAM, KMS, S3, EC2/VPC, Glue, Lambda, EventBridge, or other cross-service identifiers. - Tagging semantics, quota limits, pagination ordering, and default values. - RFC 7232 conditional headers (`If-Match`, `If-None-Match`, `If-Modified-Since`, `If-Unmodified-Since`, and service-prefixed variants such as `x-amz-copy-source-if-*`) and their HTTP error codes (412 PreconditionFailed, 409 ConditionalRequestConflict). These are rarely modelled as typed errors but are documented behaviour. Cross-check the extractor's "Conditional-write/read coverage" summary. - HTTP-method semantics, especially the HEAD response-body rule (4xx HEAD responses must not include a body; an XML body forces `aws-sdk-rust` into `Unhandled` instead of the typed `NotFound` variant). Also note redirect handling, content-length quirks, and PUT-vs-POST body semantics where the user-guide flags them. - The modelled `errors:` list is a lower bound. The API Reference's "Errors" / "Response" sections often document additional HTTP error codes (precondition failures, request conflicts, request-too-large, throttling variants) that have no typed error shape but still need to be emitted with the correct HTTP status and SDK `ErrorMetadata.code`. ### 4. Generate or Enhance the Dossier For a new dossier, create `.agents/docs/services/.md` with these sections, in this order: 1. Title. 2. Source. 3. `Service Overview`. 4. `Possible Usage Scenarios`. 5. `Service Identity and Protocol`. 6. `Behavioural Model Notes`. 7. `Official AWS Documentation Research` when official docs were read. 8. Existing durable service-specific sections, if applicable. 9. `Resource Model`. 10. `Operation Groups`. 11. `Operation Detail Matrix`. 12. `HTTP Bindings`. 13. `Important Shapes`. 14. `Research Checklist for Parity Work`. For an existing dossier: - Update stale Smithy-derived counts and tables from the current vendored model. - Add or refresh `Official AWS Documentation Research` when useful for implementation parity. - Improve `Possible Usage Scenarios` only where operation/resource names and docs support concrete workflows. - Keep scenario text actionable: "create X, attach Y, verify Z appears through list/get" is better than "test CRUD". - Treat the extractor output as a patch aid, not a replacement file. Preserve arbitrary manual edits, unknown sections, and hand-written notes unless the current Smithy model or official AWS documentation clearly contradicts them. - Be especially careful with `Research Checklist for Parity Work`, `Possible Usage Scenarios`, `Behavioural Model Notes`, and `Official AWS Documentation Research`; these often contain human judgement and LTM-derived implementation guidance even though the extractor can emit sections with the same names. - When refreshing an existing dossier whose `HTTP Bindings` section is missing (i.e., it predates the extractor's binding output), add the section using the extractor's draft. This is the single most leverage change for catching missing optional headers — conditional-write headers, idempotency-via-`x-amz-*` headers, and protocol modifier headers — that get silently dropped from hand-written handlers. - Preserve manual notes unless contradicted by newer official docs or the current model. If contradicted, state the correction precisely. ### 5. Scenario Quality Gate Before finalising scenarios, apply the LTM lessons: - Prefer concrete documented associations, attachments, memberships, targets, account defaults, jobs, executions, tasks, deployments, streams, workspaces, clusters, channels, meetings, simulations, migration tasks, lifecycle transitions, and parent-child propagation. - Include full-input/read-back and per-call uniqueness prompts where the service mints IDs or stores optional fields. - Include cross-call invariant prompts when one operation writes state another operation must later observe. - Do not imply Winterbaume already implements the scenario. - Do not invent scenarios for stateless services; explicitly keep them API/reference focused. ### 6. Update the Index If adding a dossier: - Add a row to `.agents/docs/services/INDEX.md` in model-slug order: ```markdown | [](.md) | `` | | <protocols> | <operation-count> | <resource-count> | ``` - If the dossier includes `Official AWS Documentation Research`, add the slug to the sentence at the top of the index. For SDK slug, prefer the Smithy `aws.api#service.sdkId` normalised like AWS SDK for Rust crate names. Cross-check existing index conventions for similar services. ### 7. Validate Run focused documentation checks: ```bash grep -n -E "behavior|synchroniz|optimization|organize|modeling|modeled|color|center|analyze" .agents/docs/services/<model-slug>.md git diff -- .agents/docs/services/<model-slug>.md .agents/docs/services/INDEX.md ``` The grep command is a spelling smoke test, not a hard failure: API names and URLs may legitimately contain American spellings. ## Final Report State: - The dossier path added or updated. - Whether AWS Documentation MCP research was included. - Any ambiguity in service naming or missing official docs. - That no Rust tests were run when the change is docs-only. --- Source attribution: moriyoshi Original project: https://github.com/moriyoshi/winterbaume/blob/69fed1d7fb0eb9a2738ff3274197c7591129c4cb/.agents/skills/service-dossier/SKILL.md License: Apache-2.0 License information: https://www.apache.org/licenses/LICENSE-2.0 Original upstream instructions; downloaded from Mega AI Hub. ## Upstream license notice Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ## Additional upstream notices service-dossier-a196e4e064ac/DAVEAI-UPSTREAM-NOTICE Winterbaume Copyright 2025 Winterbaume contributors This product includes software developed at https://github.com/getmoto/moto ======================================================================= Moto - Mock AWS Services ======================================================================= Copyright 2012 Steve Pulec Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. Winterbaume used moto as a reference implementation for AWS service mock behaviour and ported many of its Python test cases into Rust integration tests. The moto source is available at https://github.com/getmoto/moto. Moto is written by Steve Pulec with contributions from: Zach Smith, Dilshod Tadjibaev, Dan Berglund, Lincoln de Sousa, mhock, Ilya Sukhanov, Lucian Branescu Mihaila, Konstantinos Koukopoulos, attili, JJ Zeng, Jon Haddad, Andres Riancho, Michael Ossareh, JeffMGreg, Hugo Lopes Tavares, Chris St. Pierre, Frank Mata, Clint Ecker, Richard Eames, Kevin Glisson, Shawn Falkner-Horine, David Baumgold, Rory-Finnegan, Bobby Impollonia, Ralfas, Omer Katz, Joseph Lawson, Trey Tacon, Peter, Tyler Sanders, Gary Dalton, Chris Henry, Mike Fuller, Andy, Mike Grima, Marco Rucci, Zack Kourouma, Pior Bastida, Dustin J. Mitchell, Jean-Baptiste Barth, Tom Viner, Justin Wiley, Adam Stauffer, Guy Templeton, Michael van Tellingen, Jessie Nadler, Alex Morken, Clive Li, Jim Shields, William Richard, Alex Casalboni, Jon Beilke, Bendeguz Acs, Craig Anderson, Robert Lewis, Kyle Jones, Mickaël Schoentgen, Ariel Beck, Roman Rader, Bryan Chen, Jonas Bulik, Rita Cheung, David Acevedo, Damon Williams The full contributor list is available at https://github.com/getmoto/moto/blob/master/AUTHORS.md. ======================================================================= AWS API Models ======================================================================= Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. Winterbaume vendors a snapshot of the official AWS API Smithy models under vendor/api-models-aws/ to drive its in-tree wire-type and serialiser code generation. The upstream LICENSE and NOTICE files are preserved alongside the vendored models. The upstream source is available at https://github.com/aws/api-models-aws. # Mega AI Hub resource metadata Creator / publisher: moriyoshi Original project: https://github.com/moriyoshi/winterbaume/blob/69fed1d7fb0eb9a2738ff3274197c7591129c4cb/.agents/skills/service-dossier/SKILL.md Attribution basis: Source repository record Fields of work: Development & Engineering, Product Management Roles: Backend Developer, Data Engineer, DevOps / SRE, Product Manager, Technical Product Manager Specialties: API, Backend Tools: AWS Country applicability: Country not specified Classification basis: Source catalog labels Instruction SHA-256: 1db28b51b065918623167d71fb2ac6436135eab09ad0254013f1657eb35ae91a