docs(client-appflow): Doc only updates for clarification around OAuth2GrantType for Salesforce.

awstools · awstools · commit b381b16616f1 · 2024-10-11T18:28:31.000Z
diff --git a/clients/client-appflow/src/models/models_0.ts b/clients/client-appflow/src/models/models_0.ts
@@ -691,11 +691,6 @@ export interface SalesforceMetadata {
    *             after you log in to your Salesforce account and authorize Amazon AppFlow to access
    *             your records.</p>
    *             </dd>
-   *             <dt>CLIENT_CREDENTIALS</dt>
-   *             <dd>
-   *                <p>Amazon AppFlow passes client credentials (a client ID and client secret) when
-   *             it requests the access token from Salesforce. You provide these credentials to Amazon AppFlow when you define the connection to your Salesforce account.</p>
-   *             </dd>
    *             <dt>JWT_BEARER</dt>
    *             <dd>
    *                <p>Amazon AppFlow passes a JSON web token (JWT) when it requests the access token
@@ -705,6 +700,9 @@ export interface SalesforceMetadata {
    *             records.</p>
    *             </dd>
    *          </dl>
+   *          <note>
+   *             <p>The CLIENT_CREDENTIALS value is not supported for Salesforce.</p>
+   *          </note>
    * @public
    */
   oauth2GrantTypesSupported?: OAuth2GrantType[];
@@ -3377,11 +3375,6 @@ export interface SalesforceConnectorProfileCredentials {
    *             after you log in to your Salesforce account and authorize Amazon AppFlow to access
    *             your records.</p>
    *             </dd>
-   *             <dt>CLIENT_CREDENTIALS</dt>
-   *             <dd>
-   *                <p>Amazon AppFlow passes client credentials (a client ID and client secret) when
-   *             it requests the access token from Salesforce. You provide these credentials to Amazon AppFlow when you define the connection to your Salesforce account.</p>
-   *             </dd>
    *             <dt>JWT_BEARER</dt>
    *             <dd>
    *                <p>Amazon AppFlow passes a JSON web token (JWT) when it requests the access token
@@ -3391,6 +3384,9 @@ export interface SalesforceConnectorProfileCredentials {
    *             records.</p>
    *             </dd>
    *          </dl>
+   *          <note>
+   *             <p>The CLIENT_CREDENTIALS value is not supported for Salesforce.</p>
+   *          </note>
    * @public
    */
   oAuth2GrantType?: OAuth2GrantType;
diff --git a/codegen/sdk-codegen/aws-models/appflow.json b/codegen/sdk-codegen/aws-models/appflow.json
@@ -7886,7 +7886,7 @@
         "oAuth2GrantType": {
           "target": "com.amazonaws.appflow#OAuth2GrantType",
           "traits": {
-            "smithy.api#documentation": "<p>Specifies the OAuth 2.0 grant type that Amazon AppFlow uses when it requests an\n      access token from Salesforce. Amazon AppFlow requires an access token each time it\n      attempts to access your Salesforce records.</p>\n         <p>You can specify one of the following values:</p>\n         <dl>\n            <dt>AUTHORIZATION_CODE</dt>\n            <dd>\n               <p>Amazon AppFlow passes an authorization code when it requests the access token\n            from Salesforce. Amazon AppFlow receives the authorization code from Salesforce\n            after you log in to your Salesforce account and authorize Amazon AppFlow to access\n            your records.</p>\n            </dd>\n            <dt>CLIENT_CREDENTIALS</dt>\n            <dd>\n               <p>Amazon AppFlow passes client credentials (a client ID and client secret) when\n            it requests the access token from Salesforce. You provide these credentials to Amazon AppFlow when you define the connection to your Salesforce account.</p>\n            </dd>\n            <dt>JWT_BEARER</dt>\n            <dd>\n               <p>Amazon AppFlow passes a JSON web token (JWT) when it requests the access token\n            from Salesforce. You provide the JWT to Amazon AppFlow when you define the\n            connection to your Salesforce account. When you use this grant type, you don't need to\n            log in to your Salesforce account to authorize Amazon AppFlow to access your\n            records.</p>\n            </dd>\n         </dl>"
+            "smithy.api#documentation": "<p>Specifies the OAuth 2.0 grant type that Amazon AppFlow uses when it requests an\n      access token from Salesforce. Amazon AppFlow requires an access token each time it\n      attempts to access your Salesforce records.</p>\n         <p>You can specify one of the following values:</p>\n         <dl>\n            <dt>AUTHORIZATION_CODE</dt>\n            <dd>\n               <p>Amazon AppFlow passes an authorization code when it requests the access token\n            from Salesforce. Amazon AppFlow receives the authorization code from Salesforce\n            after you log in to your Salesforce account and authorize Amazon AppFlow to access\n            your records.</p>\n            </dd>\n            <dt>JWT_BEARER</dt>\n            <dd>\n               <p>Amazon AppFlow passes a JSON web token (JWT) when it requests the access token\n            from Salesforce. You provide the JWT to Amazon AppFlow when you define the\n            connection to your Salesforce account. When you use this grant type, you don't need to\n            log in to your Salesforce account to authorize Amazon AppFlow to access your\n            records.</p>\n            </dd>\n         </dl>\n         <note>\n            <p>The CLIENT_CREDENTIALS value is not supported for Salesforce.</p>\n         </note>"
           }
         },
         "jwtToken": {
@@ -8014,7 +8014,7 @@
         "oauth2GrantTypesSupported": {
           "target": "com.amazonaws.appflow#OAuth2GrantTypeSupportedList",
           "traits": {
-            "smithy.api#documentation": "<p>The OAuth 2.0 grant types that Amazon AppFlow can use when it requests an access\n      token from Salesforce. Amazon AppFlow requires an access token each time it attempts to\n      access your Salesforce records.</p>\n         <dl>\n            <dt>AUTHORIZATION_CODE</dt>\n            <dd>\n               <p>Amazon AppFlow passes an authorization code when it requests the access token\n            from Salesforce. Amazon AppFlow receives the authorization code from Salesforce\n            after you log in to your Salesforce account and authorize Amazon AppFlow to access\n            your records.</p>\n            </dd>\n            <dt>CLIENT_CREDENTIALS</dt>\n            <dd>\n               <p>Amazon AppFlow passes client credentials (a client ID and client secret) when\n            it requests the access token from Salesforce. You provide these credentials to Amazon AppFlow when you define the connection to your Salesforce account.</p>\n            </dd>\n            <dt>JWT_BEARER</dt>\n            <dd>\n               <p>Amazon AppFlow passes a JSON web token (JWT) when it requests the access token\n            from Salesforce. You provide the JWT to Amazon AppFlow when you define the\n            connection to your Salesforce account. When you use this grant type, you don't need to\n            log in to your Salesforce account to authorize Amazon AppFlow to access your\n            records.</p>\n            </dd>\n         </dl>"
+            "smithy.api#documentation": "<p>The OAuth 2.0 grant types that Amazon AppFlow can use when it requests an access\n      token from Salesforce. Amazon AppFlow requires an access token each time it attempts to\n      access your Salesforce records.</p>\n         <dl>\n            <dt>AUTHORIZATION_CODE</dt>\n            <dd>\n               <p>Amazon AppFlow passes an authorization code when it requests the access token\n            from Salesforce. Amazon AppFlow receives the authorization code from Salesforce\n            after you log in to your Salesforce account and authorize Amazon AppFlow to access\n            your records.</p>\n            </dd>\n            <dt>JWT_BEARER</dt>\n            <dd>\n               <p>Amazon AppFlow passes a JSON web token (JWT) when it requests the access token\n            from Salesforce. You provide the JWT to Amazon AppFlow when you define the\n            connection to your Salesforce account. When you use this grant type, you don't need to\n            log in to your Salesforce account to authorize Amazon AppFlow to access your\n            records.</p>\n            </dd>\n         </dl>\n         <note>\n            <p>The CLIENT_CREDENTIALS value is not supported for Salesforce.</p>\n         </note>"
           }
         }
       },

Original file line number	Diff line number	Diff line change
`@@ -7886,7 +7886,7 @@`
`7886`	`7886`	`"oAuth2GrantType": {`
`7887`	`7887`	`"target": "com.amazonaws.appflow#OAuth2GrantType",`
`7888`	`7888`	`"traits": {`
`7889`		- "smithy.api#documentation": "<p>Specifies the OAuth 2.0 grant type that Amazon AppFlow uses when it requests an\n access token from Salesforce. Amazon AppFlow requires an access token each time it\n attempts to access your Salesforce records.</p>\n <p>You can specify one of the following values:</p>\n <dl>\n <dt>AUTHORIZATION_CODE</dt>\n <dd>\n <p>Amazon AppFlow passes an authorization code when it requests the access token\n from Salesforce. Amazon AppFlow receives the authorization code from Salesforce\n after you log in to your Salesforce account and authorize Amazon AppFlow to access\n your records.</p>\n </dd>\n <dt>CLIENT_CREDENTIALS</dt>\n <dd>\n <p>Amazon AppFlow passes client credentials (a client ID and client secret) when\n it requests the access token from Salesforce. You provide these credentials to Amazon AppFlow when you define the connection to your Salesforce account.</p>\n </dd>\n <dt>JWT_BEARER</dt>\n <dd>\n <p>Amazon AppFlow passes a JSON web token (JWT) when it requests the access token\n from Salesforce. You provide the JWT to Amazon AppFlow when you define the\n connection to your Salesforce account. When you use this grant type, you don't need to\n log in to your Salesforce account to authorize Amazon AppFlow to access your\n records.</p>\n </dd>\n </dl>"
	`7889`	+ "smithy.api#documentation": "<p>Specifies the OAuth 2.0 grant type that Amazon AppFlow uses when it requests an\n access token from Salesforce. Amazon AppFlow requires an access token each time it\n attempts to access your Salesforce records.</p>\n <p>You can specify one of the following values:</p>\n <dl>\n <dt>AUTHORIZATION_CODE</dt>\n <dd>\n <p>Amazon AppFlow passes an authorization code when it requests the access token\n from Salesforce. Amazon AppFlow receives the authorization code from Salesforce\n after you log in to your Salesforce account and authorize Amazon AppFlow to access\n your records.</p>\n </dd>\n <dt>JWT_BEARER</dt>\n <dd>\n <p>Amazon AppFlow passes a JSON web token (JWT) when it requests the access token\n from Salesforce. You provide the JWT to Amazon AppFlow when you define the\n connection to your Salesforce account. When you use this grant type, you don't need to\n log in to your Salesforce account to authorize Amazon AppFlow to access your\n records.</p>\n </dd>\n </dl>\n <note>\n <p>The CLIENT_CREDENTIALS value is not supported for Salesforce.</p>\n </note>"
`7890`	`7890`	`}`
`7891`	`7891`	`},`
`7892`	`7892`	`"jwtToken": {`
`@@ -8014,7 +8014,7 @@`
`8014`	`8014`	`"oauth2GrantTypesSupported": {`
`8015`	`8015`	`"target": "com.amazonaws.appflow#OAuth2GrantTypeSupportedList",`
`8016`	`8016`	`"traits": {`
`8017`		- "smithy.api#documentation": "<p>The OAuth 2.0 grant types that Amazon AppFlow can use when it requests an access\n token from Salesforce. Amazon AppFlow requires an access token each time it attempts to\n access your Salesforce records.</p>\n <dl>\n <dt>AUTHORIZATION_CODE</dt>\n <dd>\n <p>Amazon AppFlow passes an authorization code when it requests the access token\n from Salesforce. Amazon AppFlow receives the authorization code from Salesforce\n after you log in to your Salesforce account and authorize Amazon AppFlow to access\n your records.</p>\n </dd>\n <dt>CLIENT_CREDENTIALS</dt>\n <dd>\n <p>Amazon AppFlow passes client credentials (a client ID and client secret) when\n it requests the access token from Salesforce. You provide these credentials to Amazon AppFlow when you define the connection to your Salesforce account.</p>\n </dd>\n <dt>JWT_BEARER</dt>\n <dd>\n <p>Amazon AppFlow passes a JSON web token (JWT) when it requests the access token\n from Salesforce. You provide the JWT to Amazon AppFlow when you define the\n connection to your Salesforce account. When you use this grant type, you don't need to\n log in to your Salesforce account to authorize Amazon AppFlow to access your\n records.</p>\n </dd>\n </dl>"
	`8017`	+ "smithy.api#documentation": "<p>The OAuth 2.0 grant types that Amazon AppFlow can use when it requests an access\n token from Salesforce. Amazon AppFlow requires an access token each time it attempts to\n access your Salesforce records.</p>\n <dl>\n <dt>AUTHORIZATION_CODE</dt>\n <dd>\n <p>Amazon AppFlow passes an authorization code when it requests the access token\n from Salesforce. Amazon AppFlow receives the authorization code from Salesforce\n after you log in to your Salesforce account and authorize Amazon AppFlow to access\n your records.</p>\n </dd>\n <dt>JWT_BEARER</dt>\n <dd>\n <p>Amazon AppFlow passes a JSON web token (JWT) when it requests the access token\n from Salesforce. You provide the JWT to Amazon AppFlow when you define the\n connection to your Salesforce account. When you use this grant type, you don't need to\n log in to your Salesforce account to authorize Amazon AppFlow to access your\n records.</p>\n </dd>\n </dl>\n <note>\n <p>The CLIENT_CREDENTIALS value is not supported for Salesforce.</p>\n </note>"
`8018`	`8018`	`}`
`8019`	`8019`	`}`
`8020`	`8020`	`},`