managedblockchainquery

package module
v1.12.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 29, 2024 License: Apache-2.0 Imports: 39 Imported by: 1

Documentation

Overview

Package managedblockchainquery provides the API client, operations, and parameter types for Amazon Managed Blockchain Query.

Amazon Managed Blockchain (AMB) Query provides you with convenient access to multi-blockchain network data, which makes it easier for you to extract contextual data related to blockchain activity. You can use AMB Query to read data from public blockchain networks, such as Bitcoin Mainnet and Ethereum Mainnet. You can also get information such as the current and historical balances of addresses, or you can get a list of blockchain transactions for a given time period. Additionally, you can get details of a given transaction, such as transaction events, which you can further analyze or use in business logic for your applications.

Index

Constants

View Source 
const ServiceAPIVersion = "2023-05-04"
View Source 
const ServiceID = "ManagedBlockchain Query"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 added in v1.1.0 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName added in v1.5.2 

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion added in v1.5.2 

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AuthResolverParameters added in v1.5.2 

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver added in v1.5.2 

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type BatchGetTokenBalanceInput 

type BatchGetTokenBalanceInput struct {

	// An array of BatchGetTokenBalanceInputItem objects whose balance is being
	// requested.
	GetTokenBalanceInputs []types.BatchGetTokenBalanceInputItem
	// contains filtered or unexported fields
}

type BatchGetTokenBalanceOutput 

type BatchGetTokenBalanceOutput struct {

	// An array of BatchGetTokenBalanceErrorItem objects returned from the request.
	//
	// This member is required.
	Errors []types.BatchGetTokenBalanceErrorItem

	// An array of BatchGetTokenBalanceOutputItem objects returned by the response.
	//
	// This member is required.
	TokenBalances []types.BatchGetTokenBalanceOutputItem

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client provides the API client to make operations call for Amazon Managed Blockchain Query.

func New 

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) BatchGetTokenBalance 

func (c *Client) BatchGetTokenBalance(ctx context.Context, params *BatchGetTokenBalanceInput, optFns ...func(*Options)) (*BatchGetTokenBalanceOutput, error)

Gets the token balance for a batch of tokens by using the BatchGetTokenBalance action for every token in the request. Only the native tokens BTC and ETH, and the ERC-20, ERC-721, and ERC 1155 token standards are supported.

func (*Client) GetAssetContract added in v1.2.0 

func (c *Client) GetAssetContract(ctx context.Context, params *GetAssetContractInput, optFns ...func(*Options)) (*GetAssetContractOutput, error)

Gets the information about a specific contract deployed on the blockchain.

  • The Bitcoin blockchain networks do not support this operation.
  • Metadata is currently only available for some ERC-20 contracts. Metadata will be available for additional contracts in the future.

func (*Client) GetTokenBalance 

func (c *Client) GetTokenBalance(ctx context.Context, params *GetTokenBalanceInput, optFns ...func(*Options)) (*GetTokenBalanceOutput, error)

Gets the balance of a specific token, including native tokens, for a given address (wallet or contract) on the blockchain. Only the native tokens BTC and ETH, and the ERC-20, ERC-721, and ERC 1155 token standards are supported.

func (*Client) GetTransaction 

func (c *Client) GetTransaction(ctx context.Context, params *GetTransactionInput, optFns ...func(*Options)) (*GetTransactionOutput, error)

Gets the details of a transaction. This action will return transaction details for all transactions that are confirmed on the blockchain, even if they have not reached finality (https://docs.aws.amazon.com/managed-blockchain/latest/ambq-dg/key-concepts.html#finality) .

func (*Client) ListAssetContracts added in v1.2.0 

func (c *Client) ListAssetContracts(ctx context.Context, params *ListAssetContractsInput, optFns ...func(*Options)) (*ListAssetContractsOutput, error)

Lists all the contracts for a given contract type deployed by an address (either a contract address or a wallet address). The Bitcoin blockchain networks do not support this operation.

func (*Client) ListFilteredTransactionEvents added in v1.11.0 

func (c *Client) ListFilteredTransactionEvents(ctx context.Context, params *ListFilteredTransactionEventsInput, optFns ...func(*Options)) (*ListFilteredTransactionEventsOutput, error)

Lists all the transaction events for an address on the blockchain. This operation is only supported on the Bitcoin networks.

func (*Client) ListTokenBalances 

func (c *Client) ListTokenBalances(ctx context.Context, params *ListTokenBalancesInput, optFns ...func(*Options)) (*ListTokenBalancesOutput, error)

This action returns the following for a given blockchain network:

  • Lists all token balances owned by an address (either a contract address or a wallet address).
  • Lists all token balances for all tokens created by a contract.
  • Lists all token balances for a given token.

You must always specify the network property of the tokenFilter when using this operation.

func (*Client) ListTransactionEvents 

func (c *Client) ListTransactionEvents(ctx context.Context, params *ListTransactionEventsInput, optFns ...func(*Options)) (*ListTransactionEventsOutput, error)

Lists all the transaction events for a transaction This action will return transaction details for all transactions that are confirmed on the blockchain, even if they have not reached finality (https://docs.aws.amazon.com/managed-blockchain/latest/ambq-dg/key-concepts.html#finality) .

func (*Client) ListTransactions 

func (c *Client) ListTransactions(ctx context.Context, params *ListTransactionsInput, optFns ...func(*Options)) (*ListTransactionsOutput, error)

Lists all the transaction events for a transaction.

func (*Client) Options added in v1.6.0 

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

type EndpointParameters added in v1.1.0 

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired added in v1.1.0 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.1.0 

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint 

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 added in v1.1.0 

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 added in v1.1.0 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetAssetContractInput added in v1.2.0 

type GetAssetContractInput struct {

	// Contains the blockchain address and network information about the contract.
	//
	// This member is required.
	ContractIdentifier *types.ContractIdentifier
	// contains filtered or unexported fields
}

type GetAssetContractOutput added in v1.2.0 

type GetAssetContractOutput struct {

	// Contains the blockchain address and network information about the contract.
	//
	// This member is required.
	ContractIdentifier *types.ContractIdentifier

	// The address of the deployer of contract.
	//
	// This member is required.
	DeployerAddress *string

	// The token standard of the contract requested.
	//
	// This member is required.
	TokenStandard types.QueryTokenStandard

	// The metadata of the contract.
	Metadata *types.ContractMetadata

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetTokenBalanceInput 

type GetTokenBalanceInput struct {

	// The container for the identifier for the owner.
	//
	// This member is required.
	OwnerIdentifier *types.OwnerIdentifier

	// The container for the identifier for the token, including the unique token ID
	// and its blockchain network.
	//
	// This member is required.
	TokenIdentifier *types.TokenIdentifier

	// The time for when the TokenBalance is requested or the current time if a time
	// is not provided in the request. This time will only be recorded up to the
	// second.
	AtBlockchainInstant *types.BlockchainInstant
	// contains filtered or unexported fields
}

type GetTokenBalanceOutput 

type GetTokenBalanceOutput struct {

	// The container for time.
	//
	// This member is required.
	AtBlockchainInstant *types.BlockchainInstant

	// The container for the token balance.
	//
	// This member is required.
	Balance *string

	// The container for time.
	LastUpdatedTime *types.BlockchainInstant

	// The container for the owner identifier.
	OwnerIdentifier *types.OwnerIdentifier

	// The container for the identifier for the token including the unique token ID
	// and its blockchain network. Only the native tokens BTC and ETH, and the ERC-20,
	// ERC-721, and ERC 1155 token standards are supported.
	TokenIdentifier *types.TokenIdentifier

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetTransactionInput 

type GetTransactionInput struct {

	// The blockchain network where the transaction occurred.
	//
	// This member is required.
	Network types.QueryNetwork

	// The hash of a transaction. It is generated when a transaction is created.
	TransactionHash *string

	// The identifier of a Bitcoin transaction. It is generated when a transaction is
	// created. transactionId is only supported on the Bitcoin networks.
	TransactionId *string
	// contains filtered or unexported fields
}

type GetTransactionOutput 

type GetTransactionOutput struct {

	// Contains the details of the transaction.
	//
	// This member is required.
	Transaction *types.Transaction

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type ListAssetContractsAPIClient added in v1.2.0 

type ListAssetContractsAPIClient interface {
	ListAssetContracts(context.Context, *ListAssetContractsInput, ...func(*Options)) (*ListAssetContractsOutput, error)
}

ListAssetContractsAPIClient is a client that implements the ListAssetContracts operation.

type ListAssetContractsInput added in v1.2.0 

type ListAssetContractsInput struct {

	// Contains the filter parameter for the request.
	//
	// This member is required.
	ContractFilter *types.ContractFilter

	// The maximum number of contracts to list. Default: 100 Even if additional
	// results can be retrieved, the request can return less results than maxResults
	// or an empty array of results. To retrieve the next set of results, make another
	// request with the returned nextToken value. The value of nextToken is null when
	// there are no more results to return
	MaxResults *int32

	// The pagination token that indicates the next set of results to retrieve.
	NextToken *string
	// contains filtered or unexported fields
}

type ListAssetContractsOutput added in v1.2.0 

type ListAssetContractsOutput struct {

	// An array of contract objects that contain the properties for each contract.
	//
	// This member is required.
	Contracts []types.AssetContract

	// The pagination token that indicates the next set of results to retrieve.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListAssetContractsPaginator added in v1.2.0 

type ListAssetContractsPaginator struct {
	// contains filtered or unexported fields
}

ListAssetContractsPaginator is a paginator for ListAssetContracts

func NewListAssetContractsPaginator added in v1.2.0 

func NewListAssetContractsPaginator(client ListAssetContractsAPIClient, params *ListAssetContractsInput, optFns ...func(*ListAssetContractsPaginatorOptions)) *ListAssetContractsPaginator

NewListAssetContractsPaginator returns a new ListAssetContractsPaginator

func (*ListAssetContractsPaginator) HasMorePages added in v1.2.0 

func (p *ListAssetContractsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAssetContractsPaginator) NextPage added in v1.2.0 

func (p *ListAssetContractsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAssetContractsOutput, error)

NextPage retrieves the next ListAssetContracts page.

type ListAssetContractsPaginatorOptions added in v1.2.0 

type ListAssetContractsPaginatorOptions struct {
	// The maximum number of contracts to list. Default: 100 Even if additional
	// results can be retrieved, the request can return less results than maxResults
	// or an empty array of results. To retrieve the next set of results, make another
	// request with the returned nextToken value. The value of nextToken is null when
	// there are no more results to return
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListAssetContractsPaginatorOptions is the paginator options for ListAssetContracts

type ListFilteredTransactionEventsAPIClient added in v1.11.0 

type ListFilteredTransactionEventsAPIClient interface {
	ListFilteredTransactionEvents(context.Context, *ListFilteredTransactionEventsInput, ...func(*Options)) (*ListFilteredTransactionEventsOutput, error)
}

ListFilteredTransactionEventsAPIClient is a client that implements the ListFilteredTransactionEvents operation.

type ListFilteredTransactionEventsInput added in v1.11.0 

type ListFilteredTransactionEventsInput struct {

	// This is the unique public address on the blockchain for which the transaction
	// events are being requested.
	//
	// This member is required.
	AddressIdentifierFilter *types.AddressIdentifierFilter

	// The blockchain network where the transaction occurred. Valid Values:
	// BITCOIN_MAINNET | BITCOIN_TESTNET
	//
	// This member is required.
	Network *string

	// The container for the ConfirmationStatusFilter that filters for the  finality  (https://docs.aws.amazon.com/managed-blockchain/latest/ambq-dg/key-concepts.html#finality)
	// of the results.
	ConfirmationStatusFilter *types.ConfirmationStatusFilter

	// The maximum number of transaction events to list. Default: 100 Even if
	// additional results can be retrieved, the request can return less results than
	// maxResults or an empty array of results. To retrieve the next set of results,
	// make another request with the returned nextToken value. The value of nextToken
	// is null when there are no more results to return
	MaxResults *int32

	// The pagination token that indicates the next set of results to retrieve.
	NextToken *string

	// The order by which the results will be sorted.
	Sort *types.ListFilteredTransactionEventsSort

	// This container specifies the time frame for the transaction events returned in
	// the response.
	TimeFilter *types.TimeFilter

	// This container specifies filtering attributes related to BITCOIN_VOUT event
	// types
	VoutFilter *types.VoutFilter
	// contains filtered or unexported fields
}

type ListFilteredTransactionEventsOutput added in v1.11.0 

type ListFilteredTransactionEventsOutput struct {

	// The transaction events returned by the request.
	//
	// This member is required.
	Events []types.TransactionEvent

	// The pagination token that indicates the next set of results to retrieve.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListFilteredTransactionEventsPaginator added in v1.11.0 

type ListFilteredTransactionEventsPaginator struct {
	// contains filtered or unexported fields
}

ListFilteredTransactionEventsPaginator is a paginator for ListFilteredTransactionEvents

func NewListFilteredTransactionEventsPaginator added in v1.11.0 

func NewListFilteredTransactionEventsPaginator(client ListFilteredTransactionEventsAPIClient, params *ListFilteredTransactionEventsInput, optFns ...func(*ListFilteredTransactionEventsPaginatorOptions)) *ListFilteredTransactionEventsPaginator

NewListFilteredTransactionEventsPaginator returns a new ListFilteredTransactionEventsPaginator

func (*ListFilteredTransactionEventsPaginator) HasMorePages added in v1.11.0 

func (p *ListFilteredTransactionEventsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListFilteredTransactionEventsPaginator) NextPage added in v1.11.0 

func (p *ListFilteredTransactionEventsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListFilteredTransactionEventsOutput, error)

NextPage retrieves the next ListFilteredTransactionEvents page.

type ListFilteredTransactionEventsPaginatorOptions added in v1.11.0 

type ListFilteredTransactionEventsPaginatorOptions struct {
	// The maximum number of transaction events to list. Default: 100 Even if
	// additional results can be retrieved, the request can return less results than
	// maxResults or an empty array of results. To retrieve the next set of results,
	// make another request with the returned nextToken value. The value of nextToken
	// is null when there are no more results to return
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListFilteredTransactionEventsPaginatorOptions is the paginator options for ListFilteredTransactionEvents

type ListTokenBalancesAPIClient 

type ListTokenBalancesAPIClient interface {
	ListTokenBalances(context.Context, *ListTokenBalancesInput, ...func(*Options)) (*ListTokenBalancesOutput, error)
}

ListTokenBalancesAPIClient is a client that implements the ListTokenBalances operation.

type ListTokenBalancesInput 

type ListTokenBalancesInput struct {

	// The contract address or a token identifier on the blockchain network by which
	// to filter the request. You must specify the contractAddress property of this
	// container when listing tokens minted by a contract. You must always specify the
	// network property of this container when using this operation.
	//
	// This member is required.
	TokenFilter *types.TokenFilter

	// The maximum number of token balances to return. Default: 100 Even if additional
	// results can be retrieved, the request can return less results than maxResults
	// or an empty array of results. To retrieve the next set of results, make another
	// request with the returned nextToken value. The value of nextToken is null when
	// there are no more results to return
	MaxResults *int32

	// The pagination token that indicates the next set of results to retrieve.
	NextToken *string

	// The contract or wallet address on the blockchain network by which to filter the
	// request. You must specify the address property of the ownerFilter when listing
	// balances of tokens owned by the address.
	OwnerFilter *types.OwnerFilter
	// contains filtered or unexported fields
}

type ListTokenBalancesOutput 

type ListTokenBalancesOutput struct {

	// An array of TokenBalance objects. Each object contains details about the token
	// balance.
	//
	// This member is required.
	TokenBalances []types.TokenBalance

	// The pagination token that indicates the next set of results to retrieve.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListTokenBalancesPaginator 

type ListTokenBalancesPaginator struct {
	// contains filtered or unexported fields
}

ListTokenBalancesPaginator is a paginator for ListTokenBalances

func NewListTokenBalancesPaginator 

func NewListTokenBalancesPaginator(client ListTokenBalancesAPIClient, params *ListTokenBalancesInput, optFns ...func(*ListTokenBalancesPaginatorOptions)) *ListTokenBalancesPaginator

NewListTokenBalancesPaginator returns a new ListTokenBalancesPaginator

func (*ListTokenBalancesPaginator) HasMorePages 

func (p *ListTokenBalancesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTokenBalancesPaginator) NextPage 

func (p *ListTokenBalancesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTokenBalancesOutput, error)

NextPage retrieves the next ListTokenBalances page.

type ListTokenBalancesPaginatorOptions 

type ListTokenBalancesPaginatorOptions struct {
	// The maximum number of token balances to return. Default: 100 Even if additional
	// results can be retrieved, the request can return less results than maxResults
	// or an empty array of results. To retrieve the next set of results, make another
	// request with the returned nextToken value. The value of nextToken is null when
	// there are no more results to return
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListTokenBalancesPaginatorOptions is the paginator options for ListTokenBalances

type ListTransactionEventsAPIClient 

type ListTransactionEventsAPIClient interface {
	ListTransactionEvents(context.Context, *ListTransactionEventsInput, ...func(*Options)) (*ListTransactionEventsOutput, error)
}

ListTransactionEventsAPIClient is a client that implements the ListTransactionEvents operation.

type ListTransactionEventsInput 

type ListTransactionEventsInput struct {

	// The blockchain network where the transaction events occurred.
	//
	// This member is required.
	Network types.QueryNetwork

	// The maximum number of transaction events to list. Default: 100 Even if
	// additional results can be retrieved, the request can return less results than
	// maxResults or an empty array of results. To retrieve the next set of results,
	// make another request with the returned nextToken value. The value of nextToken
	// is null when there are no more results to return
	MaxResults *int32

	// The pagination token that indicates the next set of results to retrieve.
	NextToken *string

	// The hash of a transaction. It is generated when a transaction is created.
	TransactionHash *string

	// The identifier of a Bitcoin transaction. It is generated when a transaction is
	// created. transactionId is only supported on the Bitcoin networks.
	TransactionId *string
	// contains filtered or unexported fields
}

type ListTransactionEventsOutput 

type ListTransactionEventsOutput struct {

	// An array of TransactionEvent objects. Each object contains details about the
	// transaction events.
	//
	// This member is required.
	Events []types.TransactionEvent

	// The pagination token that indicates the next set of results to retrieve.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListTransactionEventsPaginator 

type ListTransactionEventsPaginator struct {
	// contains filtered or unexported fields
}

ListTransactionEventsPaginator is a paginator for ListTransactionEvents

func NewListTransactionEventsPaginator 

func NewListTransactionEventsPaginator(client ListTransactionEventsAPIClient, params *ListTransactionEventsInput, optFns ...func(*ListTransactionEventsPaginatorOptions)) *ListTransactionEventsPaginator

NewListTransactionEventsPaginator returns a new ListTransactionEventsPaginator

func (*ListTransactionEventsPaginator) HasMorePages 

func (p *ListTransactionEventsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTransactionEventsPaginator) NextPage 

func (p *ListTransactionEventsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTransactionEventsOutput, error)

NextPage retrieves the next ListTransactionEvents page.

type ListTransactionEventsPaginatorOptions 

type ListTransactionEventsPaginatorOptions struct {
	// The maximum number of transaction events to list. Default: 100 Even if
	// additional results can be retrieved, the request can return less results than
	// maxResults or an empty array of results. To retrieve the next set of results,
	// make another request with the returned nextToken value. The value of nextToken
	// is null when there are no more results to return
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListTransactionEventsPaginatorOptions is the paginator options for ListTransactionEvents

type ListTransactionsAPIClient 

type ListTransactionsAPIClient interface {
	ListTransactions(context.Context, *ListTransactionsInput, ...func(*Options)) (*ListTransactionsOutput, error)
}

ListTransactionsAPIClient is a client that implements the ListTransactions operation.

type ListTransactionsInput 

type ListTransactionsInput struct {

	// The address (either a contract or wallet), whose transactions are being
	// requested.
	//
	// This member is required.
	Address *string

	// The blockchain network where the transactions occurred.
	//
	// This member is required.
	Network types.QueryNetwork

	// This filter is used to include transactions in the response that haven't
	// reached finality  (https://docs.aws.amazon.com/managed-blockchain/latest/ambq-dg/key-concepts.html#finality)
	// . Transactions that have reached finality are always part of the response.
	ConfirmationStatusFilter *types.ConfirmationStatusFilter

	// The container for time.
	FromBlockchainInstant *types.BlockchainInstant

	// The maximum number of transactions to list. Default: 100 Even if additional
	// results can be retrieved, the request can return less results than maxResults
	// or an empty array of results. To retrieve the next set of results, make another
	// request with the returned nextToken value. The value of nextToken is null when
	// there are no more results to return
	MaxResults *int32

	// The pagination token that indicates the next set of results to retrieve.
	NextToken *string

	// The order by which the results will be sorted.
	Sort *types.ListTransactionsSort

	// The container for time.
	ToBlockchainInstant *types.BlockchainInstant
	// contains filtered or unexported fields
}

type ListTransactionsOutput 

type ListTransactionsOutput struct {

	// The array of transactions returned by the request.
	//
	// This member is required.
	Transactions []types.TransactionOutputItem

	// The pagination token that indicates the next set of results to retrieve.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListTransactionsPaginator 

type ListTransactionsPaginator struct {
	// contains filtered or unexported fields
}

ListTransactionsPaginator is a paginator for ListTransactions

func NewListTransactionsPaginator 

func NewListTransactionsPaginator(client ListTransactionsAPIClient, params *ListTransactionsInput, optFns ...func(*ListTransactionsPaginatorOptions)) *ListTransactionsPaginator

NewListTransactionsPaginator returns a new ListTransactionsPaginator

func (*ListTransactionsPaginator) HasMorePages 

func (p *ListTransactionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTransactionsPaginator) NextPage 

func (p *ListTransactionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTransactionsOutput, error)

NextPage retrieves the next ListTransactions page.

type ListTransactionsPaginatorOptions 

type ListTransactionsPaginatorOptions struct {
	// The maximum number of transactions to list. Default: 100 Even if additional
	// results can be retrieved, the request can return less results than maxResults
	// or an empty array of results. To retrieve the next set of results, make another
	// request with the returned nextToken value. The value of nextToken is null when
	// there are no more results to return
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListTransactionsPaginatorOptions is the paginator options for ListTransactions

type Options 

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom
	// endpoint, set the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts. If specified in an operation call's
	// functional options with a value that is different than the constructed client's
	// Options, the Client's Retryer will be wrapped to use the operation's specific
	// RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified. When creating a new API Clients this
	// member will only be used if the Retryer Options member is nil. This value will
	// be ignored if Retryer is not nil. Currently does not support per operation call
	// overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetIdentityResolver added in v1.5.2 

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.