AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . managedblockchain-query ]

get-token-balance

Description

Gets the balance of a specific token, including native tokens, for a given address (wallet or contract) on the blockchain.

Note

Only the native tokens BTC and ETH, and the ERC-20, ERC-721, and ERC 1155 token standards are supported.

See also: AWS API Documentation

Synopsis

  get-token-balance
--token-identifier <value>
--owner-identifier <value>
[--at-blockchain-instant <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--token-identifier (structure)

The container for the identifier for the token, including the unique token ID and its blockchain network.

network -> (string)

The blockchain network of the token.

contractAddress -> (string)

This is the token's contract address.

tokenId -> (string)

The unique identifier of the token.

Note

For native tokens, use the 3 character abbreviation that best matches your token. For example, btc for Bitcoin, eth for Ether, etc. For all other token types you must specify the tokenId in the 64 character hexadecimal tokenid format.

Shorthand Syntax:

network=string,contractAddress=string,tokenId=string

JSON Syntax:

{
  "network": "ETHEREUM_MAINNET"|"ETHEREUM_SEPOLIA_TESTNET"|"BITCOIN_MAINNET"|"BITCOIN_TESTNET",
  "contractAddress": "string",
  "tokenId": "string"
}

--owner-identifier (structure)

The container for the identifier for the owner.

address -> (string)

The contract or wallet address for the owner.

Shorthand Syntax:

address=string

JSON Syntax:

{
  "address": "string"
}

--at-blockchain-instant (structure)

The time for when the TokenBalance is requested or the current time if a time is not provided in the request.

Note

This time will only be recorded up to the second.

time -> (timestamp)

The container of the Timestamp of the blockchain instant.

Note

This timestamp will only be recorded up to the second.

Shorthand Syntax:

time=timestamp

JSON Syntax:

{
  "time": timestamp
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

ownerIdentifier -> (structure)

The container for the owner identifier.

address -> (string)

The contract or wallet address for the owner.

tokenIdentifier -> (structure)

The container for the identifier for the token including the unique token ID and its blockchain network.

Note

Only the native tokens BTC and ETH, and the ERC-20, ERC-721, and ERC 1155 token standards are supported.

network -> (string)

The blockchain network of the token.

contractAddress -> (string)

This is the token's contract address.

tokenId -> (string)

The unique identifier of the token.

Note

For native tokens, use the 3 character abbreviation that best matches your token. For example, btc for Bitcoin, eth for Ether, etc. For all other token types you must specify the tokenId in the 64 character hexadecimal tokenid format.

balance -> (string)

The container for the token balance.

atBlockchainInstant -> (structure)

The container for time.

time -> (timestamp)

The container of the Timestamp of the blockchain instant.

Note

This timestamp will only be recorded up to the second.

lastUpdatedTime -> (structure)

The container for time.

time -> (timestamp)

The container of the Timestamp of the blockchain instant.

Note

This timestamp will only be recorded up to the second.