aws-sdk-bedrockagentcore 1.45.0

AWS SDK for Amazon Bedrock AgentCore
Documentation
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetPaymentInstrumentBalance`](crate::operation::get_payment_instrument_balance::builders::GetPaymentInstrumentBalanceFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`user_id(impl Into<String>)`](crate::operation::get_payment_instrument_balance::builders::GetPaymentInstrumentBalanceFluentBuilder::user_id) / [`set_user_id(Option<String>)`](crate::operation::get_payment_instrument_balance::builders::GetPaymentInstrumentBalanceFluentBuilder::set_user_id):<br>required: **false**<br><p>The user ID associated with this payment instrument.</p><br>
    ///   - [`agent_name(impl Into<String>)`](crate::operation::get_payment_instrument_balance::builders::GetPaymentInstrumentBalanceFluentBuilder::agent_name) / [`set_agent_name(Option<String>)`](crate::operation::get_payment_instrument_balance::builders::GetPaymentInstrumentBalanceFluentBuilder::set_agent_name):<br>required: **false**<br><p>The agent name associated with this request, used for observability.</p><br>
    ///   - [`payment_manager_arn(impl Into<String>)`](crate::operation::get_payment_instrument_balance::builders::GetPaymentInstrumentBalanceFluentBuilder::payment_manager_arn) / [`set_payment_manager_arn(Option<String>)`](crate::operation::get_payment_instrument_balance::builders::GetPaymentInstrumentBalanceFluentBuilder::set_payment_manager_arn):<br>required: **true**<br><p>The ARN of the payment manager that owns this payment instrument.</p><br>
    ///   - [`payment_connector_id(impl Into<String>)`](crate::operation::get_payment_instrument_balance::builders::GetPaymentInstrumentBalanceFluentBuilder::payment_connector_id) / [`set_payment_connector_id(Option<String>)`](crate::operation::get_payment_instrument_balance::builders::GetPaymentInstrumentBalanceFluentBuilder::set_payment_connector_id):<br>required: **true**<br><p>The ID of the payment connector associated with this instrument.</p><br>
    ///   - [`payment_instrument_id(impl Into<String>)`](crate::operation::get_payment_instrument_balance::builders::GetPaymentInstrumentBalanceFluentBuilder::payment_instrument_id) / [`set_payment_instrument_id(Option<String>)`](crate::operation::get_payment_instrument_balance::builders::GetPaymentInstrumentBalanceFluentBuilder::set_payment_instrument_id):<br>required: **true**<br><p>The ID of the payment instrument to query balance for.</p><br>
    ///   - [`chain(BlockchainChainId)`](crate::operation::get_payment_instrument_balance::builders::GetPaymentInstrumentBalanceFluentBuilder::chain) / [`set_chain(Option<BlockchainChainId>)`](crate::operation::get_payment_instrument_balance::builders::GetPaymentInstrumentBalanceFluentBuilder::set_chain):<br>required: **true**<br><p>The specific blockchain chain to query balance on. Required because balances are chain-specific.</p><br>
    ///   - [`token(InstrumentBalanceToken)`](crate::operation::get_payment_instrument_balance::builders::GetPaymentInstrumentBalanceFluentBuilder::token) / [`set_token(Option<InstrumentBalanceToken>)`](crate::operation::get_payment_instrument_balance::builders::GetPaymentInstrumentBalanceFluentBuilder::set_token):<br>required: **true**<br><p>The token to query balance for. Only tokens supported for X402 payments are returned.</p><br>
    /// - On success, responds with [`GetPaymentInstrumentBalanceOutput`](crate::operation::get_payment_instrument_balance::GetPaymentInstrumentBalanceOutput) with field(s):
    ///   - [`payment_instrument_id(String)`](crate::operation::get_payment_instrument_balance::GetPaymentInstrumentBalanceOutput::payment_instrument_id): <p>The ID of the payment instrument.</p>
    ///   - [`token_balance(Option<TokenBalance>)`](crate::operation::get_payment_instrument_balance::GetPaymentInstrumentBalanceOutput::token_balance): <p>The balance of the supported token on the requested chain.</p>
    /// - On failure, responds with [`SdkError<GetPaymentInstrumentBalanceError>`](crate::operation::get_payment_instrument_balance::GetPaymentInstrumentBalanceError)
    pub fn get_payment_instrument_balance(
        &self,
    ) -> crate::operation::get_payment_instrument_balance::builders::GetPaymentInstrumentBalanceFluentBuilder {
        crate::operation::get_payment_instrument_balance::builders::GetPaymentInstrumentBalanceFluentBuilder::new(self.handle.clone())
    }
}