From 07735f617da6c34a70a787bed8e8378b1dff0c59 Mon Sep 17 00:00:00 2001 From: Russell Cohen Date: Tue, 29 Jun 2021 16:30:39 -0700 Subject: [PATCH] Update aws-core.rst (#848) * Update aws-core.rst - Change `must` to `SHOULD` in reference to the suffix of `api`, `client`, and `service - Add guidance to remove the suffix for new SDK versions * Update docs/source/1.0/spec/aws/aws-core.rst --- docs/source/1.0/spec/aws/aws-core.rst | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/source/1.0/spec/aws/aws-core.rst b/docs/source/1.0/spec/aws/aws-core.rst index 8d0cdc4551a..f9667dfc1fd 100644 --- a/docs/source/1.0/spec/aws/aws-core.rst +++ b/docs/source/1.0/spec/aws/aws-core.rst @@ -123,7 +123,7 @@ generating client names in SDKs and for linking between services. the first character cannot be a number, and when using spaces, each space must be between two alphanumeric characters. * The value MUST NOT contain "AWS", "Aws", or "Amazon". -* The value must not case-insensitively end with "API", "Client", or "Service". +* The value SHOULD NOT case-insensitively end with "API", "Client", or "Service". * The value MUST NOT change change once a service is publicly released. If the value does change, the service will be considered a brand new service in the AWS SDKs and Tools. @@ -178,6 +178,10 @@ appending the word "Client" to the final transformed "serviceId". So for the Other AWS SDKs SHOULD follow a similar pattern when choosing client names. +**Note**: +For backwards compatibility reasons, some services will include "service" or "API" as a suffix. +New SDK major versions SHOULD strip ``service`` and ``api`` suffixes from ``sdkId`` when generating +a client name. .. _service-cloudformation-name: