create_connector_profile
async
¶
create_connector_profile(
connector_profile_name: ConnectorProfileName,
connector_type: ConnectorType,
connection_mode: ConnectionMode,
connector_profile_config: ConnectorProfileConfig,
*,
config_overrides: Optional[AsyncAppflowClientConfig] = None,
kms_arn: Optional[KMSArn] = None,
connector_label: Optional[ConnectorLabel] = None,
client_token: Optional[ClientToken] = None,
) -> CreateConnectorProfileResponse
Creates a new connector profile associated with your Amazon Web Services account. There is a soft quota of 100 connector profiles per Amazon Web Services account. If you need more connector profiles than this quota allows, you can submit a request to the Amazon AppFlow team through the Amazon AppFlow support channel. In each connector profile that you create, you can provide the credentials and properties for only one connector.
Parameters:
-
connector_profile_name(ConnectorProfileName) –The name of the connector profile. The name is unique for each
ConnectorProfilein your Amazon Web Services account. -
kms_arn(Optional[KMSArn], default:None) –The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.
-
connector_type(ConnectorType) –The type of connector, such as Salesforce, Amplitude, and so on.
-
connector_label(Optional[ConnectorLabel], default:None) –The label of the connector. The label is unique for each
ConnectorRegistrationin your Amazon Web Services account. Only needed if calling for CUSTOMCONNECTOR connector type/. -
connection_mode(ConnectionMode) –Indicates the connection mode and specifies whether it is public or private. Private flows use Amazon Web Services PrivateLink to route data over Amazon Web Services infrastructure without exposing it to the public internet.
-
connector_profile_config(ConnectorProfileConfig) –Defines the connector-specific configuration and credentials.
-
client_token(Optional[ClientToken], default:None) –The
clientTokenparameter is an idempotency token. It ensures that yourCreateConnectorProfilerequest 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 sameclientTokenparameter value.If you omit a
clientTokenvalue, 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 toCreateConnectorProfile. The token is active for 8 hours.
Raises:
-
ConflictException–There was a conflict when processing the request (for example, a flow with the given name already exists within the account. Check for conflicting resource names and try again.
-
ConnectorAuthenticationException–An error occurred when authenticating with the connector endpoint.
-
InternalServerException–An internal service error occurred during the processing of your request. Try again later.
-
ServiceQuotaExceededException–The request would cause a service quota (such as the number of flows) to be exceeded.
-
ValidationException–The request has invalid or missing parameters.
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_appflow/_services/async_appflow.py
280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 | |