create_payment_instrument ¶

def create_payment_instrument(
    self,
    payment_manager_arn: "capo_bedrock_agentcore.types.payment_manager_arn.PaymentManagerArn",
    payment_connector_id: "capo_bedrock_agentcore.types.payment_connector_id.PaymentConnectorId",
    payment_instrument_type: "capo_bedrock_agentcore.types.payment_instrument_type.PaymentInstrumentType",
    payment_instrument_details: "capo_bedrock_agentcore.types.payment_instrument_details.PaymentInstrumentDetails",
    *,
    config_overrides: Optional[BedrockAgentCoreClientConfig] = None,
    user_id: Optional["capo_bedrock_agentcore.types.user_id.UserId"] = None,
    agent_name: Optional[
        "capo_bedrock_agentcore.types.payment_agent_name.PaymentAgentName"
    ] = None,
    client_token: Optional[
        "capo_bedrock_agentcore.types.client_token.ClientToken"
    ] = None,
) -> "capo_bedrock_agentcore.types.create_payment_instrument_response.CreatePaymentInstrumentResponse":
    """<p>Create a new payment instrument for a connector.</p>

    Args:
        user_id: <p>The user ID associated with this payment instrument.</p>
        agent_name: <p>The agent name associated with this request, used for observability.</p>
        payment_manager_arn: <p>The ARN of the payment manager that owns this payment instrument.</p>
        payment_connector_id: <p>The ID of the payment connector to use for this instrument.</p>
        payment_instrument_type: <p>The type of payment instrument being created.</p>
        payment_instrument_details: <p>The details of the payment instrument.</p>
        client_token: <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>

    Raises:
        capo_bedrock_agentcore.errors.access_denied_exception.AccessDeniedException: <p>The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.</p>
        capo_bedrock_agentcore.errors.conflict_exception.ConflictException: <p>The exception that occurs when the request conflicts with the current state of the resource. This can happen when trying to modify a resource that is currently being modified by another request, or when trying to create a resource that already exists.</p>
        capo_bedrock_agentcore.errors.internal_server_exception.InternalServerException: <p>The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.</p>
        capo_bedrock_agentcore.errors.resource_not_found_exception.ResourceNotFoundException: <p>The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.</p>
        capo_bedrock_agentcore.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.</p>
        capo_bedrock_agentcore.errors.subscription_required_exception.SubscriptionRequiredException: <p>Returned when you attempt a wallet operation against a Coinbase Marketplace connector whose account does not hold an active Marketplace subscription and is not within the legacy exception period. Subscribe to the Marketplace listing before you retry the operation.</p>
        capo_bedrock_agentcore.errors.throttling_exception.ThrottlingException: <p>The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.</p>
        capo_bedrock_agentcore.errors.validation_exception.ValidationException: <p>The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.</p>
        capo_bedrock_agentcore.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_bedrock_agentcore.types.create_payment_instrument_request.CreatePaymentInstrumentRequest]",
    ) -> OperationResponse[
        "capo_bedrock_agentcore.types.create_payment_instrument_response.CreatePaymentInstrumentResponse"
    ]:
        import capo_bedrock_agentcore._operations.amazon_bedrock_agent_core.create_payment_instrument

        output, http_response = (
            capo_bedrock_agentcore._operations.amazon_bedrock_agent_core.create_payment_instrument.create_payment_instrument(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_bedrock_agentcore.types.create_payment_instrument_request.CreatePaymentInstrumentRequest",
    ) -> dict[str, Any]:
        import capo_bedrock_agentcore.types.create_payment_instrument_request

        return capo_bedrock_agentcore.types.create_payment_instrument_request.redact_sensitive(
            input_
        )

    def _redact_output(
        output: "capo_bedrock_agentcore.types.create_payment_instrument_response.CreatePaymentInstrumentResponse",
    ) -> dict[str, Any]:
        import capo_bedrock_agentcore.types.create_payment_instrument_response

        return capo_bedrock_agentcore.types.create_payment_instrument_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "CreatePaymentInstrument",
            redact_input=_redact_input,
            redact_output=_redact_output,
        ),
    )
    input_: capo_bedrock_agentcore.types.create_payment_instrument_request.CreatePaymentInstrumentRequest = {
        "payment_manager_arn": payment_manager_arn,
        "payment_connector_id": payment_connector_id,
        "payment_instrument_type": payment_instrument_type,
        "payment_instrument_details": payment_instrument_details,
    }
    if user_id is not None:
        input_["user_id"] = user_id
    if agent_name is not None:
        input_["agent_name"] = agent_name
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token

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