ManagedBlockchain / Client / list_accessors

list_accessors#

ManagedBlockchain.Client.list_accessors(**kwargs)#

Returns a list of the accessors and their properties. Accessor objects are containers that have the information required for token based access to your Ethereum nodes.

Request Syntax

response = client.list_accessors(
    MaxResults=123,
    NextToken='string',
    NetworkType='ETHEREUM_GOERLI'|'ETHEREUM_MAINNET'|'ETHEREUM_MAINNET_AND_GOERLI'|'POLYGON_MAINNET'|'POLYGON_MUMBAI'
)

Parameters:

MaxResults (integer) – The maximum number of accessors to list.
NextToken (string) – The pagination token that indicates the next set of results to retrieve.
NetworkType (string) –
The blockchain network that the Accessor token is created for.

Note
Use the value ETHEREUM_MAINNET_AND_GOERLI for all existing Accessors tokens that were created before the networkType property was introduced.

Return type:

dict

Returns:

Response Syntax

{
    'Accessors': [
        {
            'Id': 'string',
            'Type': 'BILLING_TOKEN',
            'Status': 'AVAILABLE'|'PENDING_DELETION'|'DELETED',
            'CreationDate': datetime(2015, 1, 1),
            'Arn': 'string',
            'NetworkType': 'ETHEREUM_GOERLI'|'ETHEREUM_MAINNET'|'ETHEREUM_MAINNET_AND_GOERLI'|'POLYGON_MAINNET'|'POLYGON_MUMBAI'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- Accessors (list) –
  
  An array of AccessorSummary objects that contain configuration properties for each accessor.
  - (dict) –
    
    A summary of accessor properties.
    - Id (string) –
      
      The unique identifier of the accessor.
    - Type (string) –
      
      The type of the accessor.
      
      Note
      Currently accessor type is restricted to BILLING_TOKEN.
    - Status (string) –
      
      The current status of the accessor.
    - CreationDate (datetime) –
      
      The creation date and time of the accessor.
    - Arn (string) –
      
      The Amazon Resource Name (ARN) of the accessor. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
    - NetworkType (string) –
      
      The blockchain network that the Accessor token is created for.
- NextToken (string) –
  
  The pagination token that indicates the next set of results to retrieve.

Exceptions

ManagedBlockchain.Client.exceptions.InvalidRequestException
ManagedBlockchain.Client.exceptions.AccessDeniedException
ManagedBlockchain.Client.exceptions.ThrottlingException
ManagedBlockchain.Client.exceptions.InternalServiceErrorException