Skip to content

SalesforceMetadata

Source code in docs_src/capo_appflow/types/salesforce_metadata.py 
13
14
15
16
17
18
19
20
21
22
23
class SalesforceMetadata(TypedDict, closed=True):
    o_auth_scopes: NotRequired["capo_appflow.types.o_auth_scope_list.OAuthScopeList"]
    """<p> The desired authorization scope for the Salesforce account. </p>"""
    data_transfer_apis: NotRequired[
        "capo_appflow.types.salesforce_data_transfer_api_list.SalesforceDataTransferApiList"
    ]
    """<p>The Salesforce APIs that you can have Amazon AppFlow use when your flows transfers data to or from Salesforce.</p>"""
    oauth2_grant_types_supported: NotRequired[
        "capo_appflow.types.o_auth2_grant_type_supported_list.OAuth2GrantTypeSupportedList"
    ]
    """<p>The OAuth 2.0 grant types that Amazon AppFlow can use when it requests an access token from Salesforce. Amazon AppFlow requires an access token each time it attempts to access your Salesforce records.</p> <dl> <dt>AUTHORIZATION_CODE</dt> <dd> <p>Amazon AppFlow passes an authorization code when it requests the access token from Salesforce. Amazon AppFlow receives the authorization code from Salesforce after you log in to your Salesforce account and authorize Amazon AppFlow to access your records.</p> </dd> <dt>JWT_BEARER</dt> <dd> <p>Amazon AppFlow passes a JSON web token (JWT) when it requests the access token from Salesforce. You provide the JWT to Amazon AppFlow when you define the connection to your Salesforce account. When you use this grant type, you don't need to log in to your Salesforce account to authorize Amazon AppFlow to access your records.</p> </dd> </dl> <note> <p>The CLIENT_CREDENTIALS value is not supported for Salesforce.</p> </note>"""

data_transfer_apis instance-attribute 

data_transfer_apis: NotRequired[SalesforceDataTransferApiList]

The Salesforce APIs that you can have Amazon AppFlow use when your flows transfers data to or from Salesforce.

o_auth_scopes instance-attribute 

o_auth_scopes: NotRequired[OAuthScopeList]

The desired authorization scope for the Salesforce account.

oauth2_grant_types_supported instance-attribute 

oauth2_grant_types_supported: NotRequired[OAuth2GrantTypeSupportedList]

The OAuth 2.0 grant types that Amazon AppFlow can use when it requests an access token from Salesforce. Amazon AppFlow requires an access token each time it attempts to access your Salesforce records.

AUTHORIZATION_CODE

Amazon AppFlow passes an authorization code when it requests the access token from Salesforce. Amazon AppFlow receives the authorization code from Salesforce after you log in to your Salesforce account and authorize Amazon AppFlow to access your records.

JWT_BEARER

Amazon AppFlow passes a JSON web token (JWT) when it requests the access token from Salesforce. You provide the JWT to Amazon AppFlow when you define the connection to your Salesforce account. When you use this grant type, you don't need to log in to your Salesforce account to authorize Amazon AppFlow to access your records.

The CLIENT_CREDENTIALS value is not supported for Salesforce.