rotate_payment_connector_credentials
async
¶
rotate_payment_connector_credentials(
payment_manager_id: PaymentManagerId,
payment_connector_id: PaymentConnectorId,
credentials_to_rotate: CredentialRotationConfig,
*,
config_overrides: Optional[AsyncBedrockAgentCoreControlClientConfig] = None,
client_token: Optional[ClientToken] = None,
) -> RotatePaymentConnectorCredentialsResponse
Replaces the service-managed credentials of a payment connector with newly issued credentials.
Use this operation only for payment connectors with a provisionMode of QUICK_CREATE. For payment connectors with a provisionMode of MANUAL, call UpdatePaymentCredentialProvider instead after rotating credentials with the payment provider directly.
The rotation finishes before the response is returned, and only one rotation runs at a time for a given payment connector. When it succeeds, the new credential is in effect and the payment connector stays in the READY state. When it fails, an error is returned, the payment connector and its existing credential are left unchanged, and you can retry the request.
Rotation replaces the credential on the connector's credential provider, so every payment connector that uses that provider is affected. Replace any copy of the previous credential that you use outside AgentCore.
Parameters:
-
payment_manager_id(PaymentManagerId) –The unique identifier of the parent payment manager.
-
payment_connector_id(PaymentConnectorId) –The unique identifier of the payment connector whose credentials you want to rotate.
-
credentials_to_rotate(CredentialRotationConfig) –The credentials to rotate. Specify the member that matches the payment connector's
type. Each credential that you select is rotated independently. -
client_token(Optional[ClientToken], default:None) –A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
Raises:
-
AccessDeniedException–This exception is thrown when a request is denied per access permissions
-
ConflictException–This exception is thrown when there is a conflict performing an operation
-
InternalServerException–This exception is thrown if there was an unexpected error during processing of request
-
ResourceNotFoundException–This exception is thrown when a resource referenced by the operation does not exist
-
ThrottlingException–This exception is thrown when the number of requests exceeds the limit
-
ValidationException–The input fails to satisfy the constraints specified by the service.
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_bedrock_agentcore_control/_services/async_bedrock_agent_core_control.py
11277 11278 11279 11280 11281 11282 11283 11284 11285 11286 11287 11288 11289 11290 11291 11292 11293 11294 11295 11296 11297 11298 11299 11300 11301 11302 11303 11304 11305 11306 11307 11308 11309 11310 11311 11312 11313 11314 11315 11316 11317 11318 11319 11320 11321 11322 11323 11324 11325 11326 11327 11328 11329 11330 11331 11332 11333 11334 11335 11336 11337 11338 11339 | |