Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update restJson1 error serialization docs #1099

Merged
merged 1 commit into from
Feb 24, 2022
Merged

Update restJson1 error serialization docs #1099

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions docs/source/1.0/spec/aws/aws-restjson1-protocol.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -312,10 +312,13 @@ Operation error serialization

Error responses in the ``restJson1`` protocol are serialized identically to
standard responses with one additional component to distinguish which error
is contained. The component MUST be one of the following: an additional header
with the name ``X-Amzn-Errortype``, a body field with the name ``code``, or a
body field named ``__type``. The value of this component SHOULD contain only
the :token:`shape name <smithy:identifier>` of the error's :ref:`shape-id`.
is contained. New server-side protocol implementations MUST use a header field
named ``X-Amzn-Errortype``. Clients MUST accept any one of the following: an
additional header with the name ``X-Amzn-Errortype``, a body field with the
name ``__type``, or a body field named ``code
``. The value of this component
SHOULD contain only the :token:`shape name <smithy:identifier>` of the error's
:ref:`shape-id`.

Legacy server-side protocol implementations sometimes include additional
information in this value. New server-side protocol implementations SHOULD NOT
Expand Down