Skip to content

UpdateConnectorProfileRequest

Source code in docs_src/capo_appflow/types/update_connector_profile_request.py
class UpdateConnectorProfileRequest(TypedDict, closed=True):
    connector_profile_name: (
        "capo_appflow.types.connector_profile_name.ConnectorProfileName"
    )
    """<p> The name of the connector profile and is unique for each <code>ConnectorProfile</code> in the Amazon Web Services account. </p>"""
    connection_mode: "capo_appflow.types.connection_mode.ConnectionMode"
    """<p> Indicates the connection mode and if it is public or private. </p>"""
    connector_profile_config: (
        "capo_appflow.types.connector_profile_config.ConnectorProfileConfig"
    )
    """<p> Defines the connector-specific profile configuration and credentials. </p>"""
    client_token: NotRequired["capo_appflow.types.client_token.ClientToken"]
    """<p>The <code>clientToken</code> parameter is an idempotency token. It ensures that your <code>UpdateConnectorProfile</code> request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the same <code>clientToken</code> parameter value.</p> <p>If you omit a <code>clientToken</code> value, the Amazon Web Services SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases.</p> <p>If you specify input parameters that differ from your first request, an error occurs. If you use a different value for <code>clientToken</code>, Amazon AppFlow considers it a new call to <code>UpdateConnectorProfile</code>. The token is active for 8 hours.</p>"""

client_token instance-attribute

client_token: NotRequired[ClientToken]

The clientToken parameter is an idempotency token. It ensures that your UpdateConnectorProfile request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the same clientToken parameter value.

If you omit a clientToken value, the Amazon Web Services SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases.

If you specify input parameters that differ from your first request, an error occurs. If you use a different value for clientToken, Amazon AppFlow considers it a new call to UpdateConnectorProfile. The token is active for 8 hours.

connection_mode instance-attribute

connection_mode: ConnectionMode

Indicates the connection mode and if it is public or private.

connector_profile_config instance-attribute

connector_profile_config: ConnectorProfileConfig

Defines the connector-specific profile configuration and credentials.

connector_profile_name instance-attribute

connector_profile_name: ConnectorProfileName

The name of the connector profile and is unique for each ConnectorProfile in the Amazon Web Services account.