aws_sdk_managedblockchainquery/client/list_transaction_events.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`ListTransactionEvents`](crate::operation::list_transaction_events::builders::ListTransactionEventsFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_transaction_events::builders::ListTransactionEventsFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`transaction_hash(impl Into<String>)`](crate::operation::list_transaction_events::builders::ListTransactionEventsFluentBuilder::transaction_hash) / [`set_transaction_hash(Option<String>)`](crate::operation::list_transaction_events::builders::ListTransactionEventsFluentBuilder::set_transaction_hash):<br>required: **false**<br><p>The hash of a transaction. It is generated when a transaction is created.</p><br>
8 /// - [`transaction_id(impl Into<String>)`](crate::operation::list_transaction_events::builders::ListTransactionEventsFluentBuilder::transaction_id) / [`set_transaction_id(Option<String>)`](crate::operation::list_transaction_events::builders::ListTransactionEventsFluentBuilder::set_transaction_id):<br>required: **false**<br><p>The identifier of a Bitcoin transaction. It is generated when a transaction is created.</p><note> <p><code>transactionId</code> is only supported on the Bitcoin networks.</p> </note><br>
9 /// - [`network(QueryNetwork)`](crate::operation::list_transaction_events::builders::ListTransactionEventsFluentBuilder::network) / [`set_network(Option<QueryNetwork>)`](crate::operation::list_transaction_events::builders::ListTransactionEventsFluentBuilder::set_network):<br>required: **true**<br><p>The blockchain network where the transaction events occurred.</p><br>
10 /// - [`next_token(impl Into<String>)`](crate::operation::list_transaction_events::builders::ListTransactionEventsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_transaction_events::builders::ListTransactionEventsFluentBuilder::set_next_token):<br>required: **false**<br><p>The pagination token that indicates the next set of results to retrieve.</p><br>
11 /// - [`max_results(i32)`](crate::operation::list_transaction_events::builders::ListTransactionEventsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_transaction_events::builders::ListTransactionEventsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of transaction events to list.</p> <p>Default: <code>100</code></p><note> <p>Even if additional results can be retrieved, the request can return less results than <code>maxResults</code> or an empty array of results.</p> <p>To retrieve the next set of results, make another request with the returned <code>nextToken</code> value. The value of <code>nextToken</code> is <code>null</code> when there are no more results to return</p> </note><br>
12 /// - On success, responds with [`ListTransactionEventsOutput`](crate::operation::list_transaction_events::ListTransactionEventsOutput) with field(s):
13 /// - [`events(Vec::<TransactionEvent>)`](crate::operation::list_transaction_events::ListTransactionEventsOutput::events): <p>An array of <code>TransactionEvent</code> objects. Each object contains details about the transaction events.</p>
14 /// - [`next_token(Option<String>)`](crate::operation::list_transaction_events::ListTransactionEventsOutput::next_token): <p>The pagination token that indicates the next set of results to retrieve.</p>
15 /// - On failure, responds with [`SdkError<ListTransactionEventsError>`](crate::operation::list_transaction_events::ListTransactionEventsError)
16 pub fn list_transaction_events(&self) -> crate::operation::list_transaction_events::builders::ListTransactionEventsFluentBuilder {
17 crate::operation::list_transaction_events::builders::ListTransactionEventsFluentBuilder::new(self.handle.clone())
18 }
19}