Skip to content

RegisterConnectorRequest

Source code in docs_src/capo_appflow/types/register_connector_request.py
class RegisterConnectorRequest(TypedDict, closed=True):
    connector_label: NotRequired["capo_appflow.types.connector_label.ConnectorLabel"]
    """<p> The name of the connector. The name is unique for each <code>ConnectorRegistration</code> in your Amazon Web Services account.</p>"""
    description: NotRequired["capo_appflow.types.description.Description"]
    """<p>A description about the connector that's being registered.</p>"""
    connector_provisioning_type: NotRequired[
        "capo_appflow.types.connector_provisioning_type.ConnectorProvisioningType"
    ]
    """<p>The provisioning type of the connector. Currently the only supported value is LAMBDA. </p>"""
    connector_provisioning_config: NotRequired[
        "capo_appflow.types.connector_provisioning_config.ConnectorProvisioningConfig"
    ]
    """<p>The provisioning type of the connector. Currently the only supported value is LAMBDA.</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>RegisterConnector</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>RegisterConnector</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 RegisterConnector 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 RegisterConnector. The token is active for 8 hours.

connector_label instance-attribute

connector_label: NotRequired[ConnectorLabel]

The name of the connector. The name is unique for each ConnectorRegistration in your Amazon Web Services account.

connector_provisioning_config instance-attribute

connector_provisioning_config: NotRequired[ConnectorProvisioningConfig]

The provisioning type of the connector. Currently the only supported value is LAMBDA.

connector_provisioning_type instance-attribute

connector_provisioning_type: NotRequired[ConnectorProvisioningType]

The provisioning type of the connector. Currently the only supported value is LAMBDA.

description instance-attribute

description: NotRequired[Description]

A description about the connector that's being registered.