Skip to content

update_payment_manager

update_payment_manager(
    payment_manager_id: PaymentManagerId,
    *,
    config_overrides: Optional[BedrockAgentCoreControlClientConfig] = None,
    description: Optional[PaymentsDescription] = None,
    authorizer_type: Optional[PaymentsAuthorizerType] = None,
    authorizer_configuration: Optional[AuthorizerConfiguration] = None,
    role_arn: Optional[RoleArn] = None,
    client_token: Optional[ClientToken] = None,
    kms_key_arn: Optional[KmsKeyArn] = None,
) -> UpdatePaymentManagerResponse

Updates an existing payment manager. This operation uses PATCH semantics, so you only need to specify the fields you want to change.

Parameters:

  • payment_manager_id (PaymentManagerId) –

    The unique identifier of the payment manager to update.

  • description (Optional[PaymentsDescription], default: None ) –

    The updated description of the payment manager.

  • authorizer_type (Optional[PaymentsAuthorizerType], default: None ) –

    The updated authorizer type for the payment manager.

  • authorizer_configuration (Optional[AuthorizerConfiguration], default: None ) –

    The updated authorizer configuration for the payment manager.

  • role_arn (Optional[RoleArn], default: None ) –

    The updated Amazon Resource Name (ARN) of the IAM role for the payment manager.

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

  • kms_key_arn (Optional[KmsKeyArn], default: None ) –

    The updated Amazon Resource Name (ARN) of the customer managed KMS key used to encrypt sensitive payment manager data at rest.

Raises:

Source code in docs_src/capo_bedrock_agentcore_control/_services/bedrock_agent_core_control.py
def update_payment_manager(
    self,
    payment_manager_id: "capo_bedrock_agentcore_control.types.payment_manager_id.PaymentManagerId",
    *,
    config_overrides: Optional[BedrockAgentCoreControlClientConfig] = None,
    description: Optional[
        "capo_bedrock_agentcore_control.types.payments_description.PaymentsDescription"
    ] = None,
    authorizer_type: Optional[
        "capo_bedrock_agentcore_control.types.payments_authorizer_type.PaymentsAuthorizerType"
    ] = None,
    authorizer_configuration: Optional[
        "capo_bedrock_agentcore_control.types.authorizer_configuration.AuthorizerConfiguration"
    ] = None,
    role_arn: Optional[
        "capo_bedrock_agentcore_control.types.role_arn.RoleArn"
    ] = None,
    client_token: Optional[
        "capo_bedrock_agentcore_control.types.client_token.ClientToken"
    ] = None,
    kms_key_arn: Optional[
        "capo_bedrock_agentcore_control.types.kms_key_arn.KmsKeyArn"
    ] = None,
) -> "capo_bedrock_agentcore_control.types.update_payment_manager_response.UpdatePaymentManagerResponse":
    """<p>Updates an existing payment manager. This operation uses PATCH semantics, so you only need to specify the fields you want to change.</p>

    Args:
        payment_manager_id: <p>The unique identifier of the payment manager to update.</p>
        description: <p>The updated description of the payment manager.</p>
        authorizer_type: <p>The updated authorizer type for the payment manager.</p>
        authorizer_configuration: <p>The updated authorizer configuration for the payment manager.</p>
        role_arn: <p>The updated Amazon Resource Name (ARN) of the IAM role for the payment manager.</p>
        client_token: <p>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 <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
        kms_key_arn: <p>The updated Amazon Resource Name (ARN) of the customer managed KMS key used to encrypt sensitive payment manager data at rest.</p>

    Raises:
        capo_bedrock_agentcore_control.errors.access_denied_exception.AccessDeniedException: <p>This exception is thrown when a request is denied per access permissions</p>
        capo_bedrock_agentcore_control.errors.conflict_exception.ConflictException: <p>This exception is thrown when there is a conflict performing an operation</p>
        capo_bedrock_agentcore_control.errors.internal_server_exception.InternalServerException: <p>This exception is thrown if there was an unexpected error during processing of request</p>
        capo_bedrock_agentcore_control.errors.resource_not_found_exception.ResourceNotFoundException: <p>This exception is thrown when a resource referenced by the operation does not exist</p>
        capo_bedrock_agentcore_control.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>This exception is thrown when a request is made beyond the service quota</p>
        capo_bedrock_agentcore_control.errors.throttling_exception.ThrottlingException: <p>This exception is thrown when the number of requests exceeds the limit</p>
        capo_bedrock_agentcore_control.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by the service.</p>
        capo_bedrock_agentcore_control.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_bedrock_agentcore_control.types.update_payment_manager_request.UpdatePaymentManagerRequest]",
    ) -> OperationResponse[
        "capo_bedrock_agentcore_control.types.update_payment_manager_response.UpdatePaymentManagerResponse"
    ]:
        import capo_bedrock_agentcore_control._operations.amazon_bedrock_agent_core_control.update_payment_manager

        output, http_response = (
            capo_bedrock_agentcore_control._operations.amazon_bedrock_agent_core_control.update_payment_manager.update_payment_manager(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdatePaymentManager")
    )
    input_: capo_bedrock_agentcore_control.types.update_payment_manager_request.UpdatePaymentManagerRequest = {
        "payment_manager_id": payment_manager_id
    }
    if description is not None:
        input_["description"] = description
    if authorizer_type is not None:
        input_["authorizer_type"] = authorizer_type
    if authorizer_configuration is not None:
        input_["authorizer_configuration"] = authorizer_configuration
    if role_arn is not None:
        input_["role_arn"] = role_arn
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token
    if kms_key_arn is not None:
        input_["kms_key_arn"] = kms_key_arn

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output