update_connection
async
¶
update_connection(
name: ConnectionName,
*,
config_overrides: Optional[AsyncEventBridgeClientConfig] = None,
description: Optional[ConnectionDescription] = None,
authorization_type: Optional[ConnectionAuthorizationType] = None,
auth_parameters: Optional[UpdateConnectionAuthRequestParameters] = None,
invocation_connectivity_parameters: Optional[ConnectivityResourceParameters] = None,
kms_key_identifier: Optional[KmsKeyIdentifier] = None,
) -> UpdateConnectionResponse
Updates settings for a connection.
Parameters:
-
name(ConnectionName) –The name of the connection to update.
-
description(Optional[ConnectionDescription], default:None) –A description for the connection.
-
authorization_type(Optional[ConnectionAuthorizationType], default:None) –The type of authorization to use for the connection.
-
auth_parameters(Optional[UpdateConnectionAuthRequestParameters], default:None) –The authorization parameters to use for the connection.
-
invocation_connectivity_parameters(Optional[ConnectivityResourceParameters], default:None) –For connections to private APIs, the parameters to use for invoking the API.
For more information, see Connecting to private APIs in the Amazon EventBridge User Guide .
-
kms_key_identifier(Optional[KmsKeyIdentifier], default:None) –The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this connection. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.
If you do not specify a customer managed key identifier, EventBridge uses an Amazon Web Services owned key to encrypt the connection.
For more information, see Identify and view keys in the Key Management Service Developer Guide.
Raises:
-
AccessDeniedException–You do not have the necessary permissions for this action.
-
ConcurrentModificationException–There is concurrent modification on a rule, target, archive, or replay.
-
InternalException–This exception occurs due to unexpected causes.
-
LimitExceededException–The request failed because it attempted to create resource beyond the allowed service quota.
-
ResourceNotFoundException–An entity that you specified does not exist.
-
ThrottlingException–This request cannot be completed due to throttling issues.
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_eventbridge/_services/async_event_bridge.py
3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 | |