Skip to content

create_payment_session

create_payment_session(
    payment_manager_arn: PaymentManagerArn,
    expiry_time_in_minutes: int,
    *,
    config_overrides: Optional[BedrockAgentCoreClientConfig] = None,
    user_id: Optional[UserId] = None,
    agent_name: Optional[PaymentAgentName] = None,
    limits: Optional[SessionLimits] = None,
    client_token: Optional[ClientToken] = None,
) -> CreatePaymentSessionResponse

Create a new payment session.

Parameters:

  • user_id (Optional[UserId], default: None ) –

    The user ID associated with this payment session.

  • agent_name (Optional[PaymentAgentName], default: None ) –

    The agent name associated with this request, used for observability.

  • payment_manager_arn (PaymentManagerArn) –

    The ARN of the payment manager that owns this session.

  • limits (Optional[SessionLimits], default: None ) –

    The spending limits for this payment session.

  • expiry_time_in_minutes (int) –

    The session expiry time in minutes. Must be between 15 and 480 minutes.

  • client_token (Optional[ClientToken], default: None ) –

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Raises:

  • AccessDeniedException –

    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.

  • ConflictException –

    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.

  • InternalServerException –

    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.

  • ServiceQuotaExceededException –

    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.

  • SubscriptionRequiredException –

    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.

  • ThrottlingException –

    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.

  • ValidationException –

    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.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_bedrock_agentcore/_services/bedrock_agent_core.py
def create_payment_session(
    self,
    payment_manager_arn: "capo_bedrock_agentcore.types.payment_manager_arn.PaymentManagerArn",
    expiry_time_in_minutes: int,
    *,
    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,
    limits: Optional[
        "capo_bedrock_agentcore.types.session_limits.SessionLimits"
    ] = None,
    client_token: Optional[
        "capo_bedrock_agentcore.types.client_token.ClientToken"
    ] = None,
) -> "capo_bedrock_agentcore.types.create_payment_session_response.CreatePaymentSessionResponse":
    """<p>Create a new payment session.</p>

    Args:
        user_id: <p>The user ID associated with this payment session.</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 session.</p>
        limits: <p>The spending limits for this payment session.</p>
        expiry_time_in_minutes: <p>The session expiry time in minutes. Must be between 15 and 480 minutes.</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.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_session_request.CreatePaymentSessionRequest]",
    ) -> OperationResponse[
        "capo_bedrock_agentcore.types.create_payment_session_response.CreatePaymentSessionResponse"
    ]:
        import capo_bedrock_agentcore._operations.amazon_bedrock_agent_core.create_payment_session

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreatePaymentSession")
    )
    input_: capo_bedrock_agentcore.types.create_payment_session_request.CreatePaymentSessionRequest = {
        "payment_manager_arn": payment_manager_arn,
        "expiry_time_in_minutes": expiry_time_in_minutes,
    }
    if user_id is not None:
        input_["user_id"] = user_id
    if agent_name is not None:
        input_["agent_name"] = agent_name
    if limits is not None:
        input_["limits"] = limits
    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