AWS API Changes

2023/11/27 - Amazon Managed Blockchain - 3 updated api methods

Changes Add optional NetworkType property to Accessor APIs

CreateAccessor (updated)

Link ¶
Changes (both)

{'NetworkType': 'ETHEREUM_GOERLI | ETHEREUM_MAINNET | '
                'ETHEREUM_MAINNET_AND_GOERLI | POLYGON_MAINNET | '
                'POLYGON_MUMBAI'}

Creates a new accessor for use with Amazon Managed Blockchain service that supports token based access. The accessor contains information required for token based access.

See also: AWS API Documentation

Request Syntax

client.create_accessor(
    ClientRequestToken='string',
    AccessorType='BILLING_TOKEN',
    Tags={
        'string': 'string'
    },
    NetworkType='ETHEREUM_GOERLI'|'ETHEREUM_MAINNET'|'ETHEREUM_MAINNET_AND_GOERLI'|'POLYGON_MAINNET'|'POLYGON_MUMBAI'
)

type ClientRequestToken

string

param ClientRequestToken

[REQUIRED]

This is a unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once. This identifier is required only if you make a service request directly using an HTTP client. It is generated automatically if you use an Amazon Web Services SDK or the Amazon Web Services CLI.

This field is autopopulated if not provided.

type AccessorType

string

param AccessorType

[REQUIRED]

The type of accessor.

Note

Currently, accessor type is restricted to BILLING_TOKEN .

type Tags

dict

param Tags

Tags to assign to the Accessor.

Each tag consists of a key and an optional value. You can specify multiple key-value pairs in a single request with an overall maximum of 50 tags allowed per resource.

For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Ethereum Developer Guide , or Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide .

(string) --
- (string) --

type NetworkType

string

param NetworkType

The blockchain network that the Accessor token is created for.

Note

We recommend using the appropriate networkType value for the blockchain network that you are creating the Accessor token for. You cannnot use the value ETHEREUM_MAINNET_AND_GOERLI to specify a networkType for your Accessor token.

The default value of ETHEREUM_MAINNET_AND_GOERLI is only applied:

when the CreateAccessor action does not set a networkType .
to all existing Accessor tokens that were created before the networkType property was introduced.

rtype

dict

returns

Response Syntax

{
    'AccessorId': 'string',
    'BillingToken': 'string',
    'NetworkType': 'ETHEREUM_GOERLI'|'ETHEREUM_MAINNET'|'ETHEREUM_MAINNET_AND_GOERLI'|'POLYGON_MAINNET'|'POLYGON_MUMBAI'
}

Response Structure

(dict) --
- AccessorId (string) --
  
  The unique identifier of the accessor.
- BillingToken (string) --
  
  The billing token is a property of the Accessor. Use this token to when making calls to the blockchain network. The billing token is used to track your accessor token for billing requests.
- NetworkType (string) --
  
  The blockchain network that the accessor token is created for.

GetAccessor (updated)

Link ¶
Changes (response)

{'Accessor': {'NetworkType': 'ETHEREUM_GOERLI | ETHEREUM_MAINNET | '
                             'ETHEREUM_MAINNET_AND_GOERLI | POLYGON_MAINNET | '
                             'POLYGON_MUMBAI'}}

Returns detailed information about an accessor. An accessor object is a container that has the information required for token based access to your Ethereum nodes.

See also: AWS API Documentation

Request Syntax

client.get_accessor(
    AccessorId='string'
)

type AccessorId

string

param AccessorId

[REQUIRED]

The unique identifier of the accessor.

rtype

dict

returns

Response Syntax

{
    'Accessor': {
        'Id': 'string',
        'Type': 'BILLING_TOKEN',
        'BillingToken': 'string',
        'Status': 'AVAILABLE'|'PENDING_DELETION'|'DELETED',
        'CreationDate': datetime(2015, 1, 1),
        'Arn': 'string',
        'Tags': {
            'string': 'string'
        },
        'NetworkType': 'ETHEREUM_GOERLI'|'ETHEREUM_MAINNET'|'ETHEREUM_MAINNET_AND_GOERLI'|'POLYGON_MAINNET'|'POLYGON_MUMBAI'
    }
}

Response Structure

(dict) --
- Accessor (dict) --
  
  The properties of the accessor.
  - Id (string) --
    
    The unique identifier of the accessor.
  - Type (string) --
    
    The type of the accessor.
    
    Note
    
    Currently, accessor type is restricted to BILLING_TOKEN .
  - BillingToken (string) --
    
    The billing token is a property of the Accessor. Use this token to when making calls to the blockchain network. The billing token is used to track your accessor token for billing requests.
  - 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 .
  - Tags (dict) --
    
    The tags assigned to the Accessor.
    
    For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Ethereum Developer Guide , or Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide .
    - (string) --
      - (string) --
  - NetworkType (string) --
    
    The blockchain network that the Accessor token is created for.

ListAccessors (updated)

Link ¶
Changes (request, response)
Request

{'NetworkType': 'ETHEREUM_GOERLI | ETHEREUM_MAINNET | '
                'ETHEREUM_MAINNET_AND_GOERLI | POLYGON_MAINNET | '
                'POLYGON_MUMBAI'}

Response

{'Accessors': {'NetworkType': 'ETHEREUM_GOERLI | ETHEREUM_MAINNET | '
                              'ETHEREUM_MAINNET_AND_GOERLI | POLYGON_MAINNET | '
                              'POLYGON_MUMBAI'}}

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.

See also: AWS API Documentation

Request Syntax

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

type MaxResults

integer

param MaxResults

The maximum number of accessors to list.

type NextToken

string

param NextToken

The pagination token that indicates the next set of results to retrieve.

type NetworkType

string

param NetworkType

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.

rtype

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.