Skip to content

Replaces the service-managed credentials of a payment connector with newly issued credentials

Description

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 update_payment_credential_provider 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.

Usage

bedrockagentcorecontrol_rotate_payment_connector_credentials(
  paymentManagerId, paymentConnectorId, credentialsToRotate, clientToken)

Arguments

  • paymentManagerId

    [required] The unique identifier of the parent payment manager.

  • paymentConnectorId

    [required] The unique identifier of the payment connector whose credentials you want to rotate.

  • credentialsToRotate

    [required] The credentials to rotate. Specify the member that matches the payment connector's type. Each credential that you select is rotated independently.

  • clientToken

    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.

Value

A list with the following syntax:

list(
  paymentConnectorId = "string",
  paymentManagerId = "string",
  lastUpdatedAt = as.POSIXct(
    "2015-01-01"
  ),
  status = "CREATING"|"UPDATING"|"DELETING"|"READY"|"CREATE_FAILED"|"UPDATE_FAILED"|"DELETE_FAILED"|"AWS_MARKETPLACE_SUBSCRIPTION_REQUIRED"|"PENDING_AUTHENTICATION"|"PROVISIONING"|"AUTHENTICATION_EXPIRED"|"AUTHENTICATION_FAILED"
)

Request syntax

svc$rotate_payment_connector_credentials(
  paymentManagerId = "string",
  paymentConnectorId = "string",
  credentialsToRotate = list(
    coinbaseCDP = list(
      secrets = list(
        "API_KEY"|"WALLET_SECRET"
      )
    )
  ),
  clientToken = "string"
)