accessors

Creates, updates, deletes, gets or lists an accessors resource.

Overview

Name	accessors
Type	Resource
Id	aws.managedblockchain.accessors

Fields

The following fields are returned by SELECT queries:

get_accessor

Name	Datatype	Description
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. (pattern: <code>^arn:.+:.+:.+:.+:.+</code>)
billing_token	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.
creation_date	string (date-time)	The creation date and time of the accessor.
id	string	The unique identifier of the accessor.
network_type	string	The blockchain network that the Accessor token is created for. (ETHEREUM_GOERLI, ETHEREUM_MAINNET, ETHEREUM_MAINNET_AND_GOERLI, POLYGON_MAINNET, POLYGON_MUMBAI)
status	string	The current status of the accessor. (AVAILABLE, PENDING_DELETION, DELETED)
tags	object	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.
type	string	The type of the accessor. Currently, accessor type is restricted to BILLING_TOKEN. (BILLING_TOKEN)

list_accessors

Name	Datatype	Description
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. (pattern: <code>^arn:.+:.+:.+:.+:.+</code>)
creation_date	string (date-time)	The creation date and time of the accessor.
id	string	The unique identifier of the accessor.
network_type	string	The blockchain network that the Accessor token is created for. (ETHEREUM_GOERLI, ETHEREUM_MAINNET, ETHEREUM_MAINNET_AND_GOERLI, POLYGON_MAINNET, POLYGON_MUMBAI)
status	string	The current status of the accessor. (AVAILABLE, PENDING_DELETION, DELETED)
type	string	The type of the accessor. Currently accessor type is restricted to BILLING_TOKEN. (BILLING_TOKEN)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_accessor	select	accessor_id, region		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.
list_accessors	select	region	maxResults, nextToken, networkType	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.
create_accessor	insert	region, ClientRequestToken, AccessorType		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.
delete_accessor	delete	accessor_id, region		Deletes an accessor that your Amazon Web Services account owns. An accessor object is a container that has the information required for token based access to your Ethereum nodes including, the BILLING_TOKEN. After an accessor is deleted, the status of the accessor changes from AVAILABLE to PENDING_DELETION. An accessor in the PENDING_DELETION state can’t be used for new WebSocket requests or HTTP requests. However, WebSocket connections that were initiated while the accessor was in the AVAILABLE state remain open until they expire (up to 2 hours).

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
accessor_id	string	The unique identifier of the accessor.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of accessors to list.
networkType	string	The blockchain network that the Accessor token is created for. Use the value ETHEREUM_MAINNET_AND_GOERLI for all existing Accessors tokens that were created before the networkType property was introduced.
nextToken	string	The pagination token that indicates the next set of results to retrieve.

SELECT examples

get_accessor

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.

SELECT
arn,
billing_token,
creation_date,
id,
network_type,
status,
tags,
type
FROM aws.managedblockchain.accessors
WHERE accessor_id = '{{ accessor_id }}' -- required
AND region = '{{ region }}' -- required
;

list_accessors

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.

SELECT
arn,
creation_date,
id,
network_type,
status,
type
FROM aws.managedblockchain.accessors
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
AND networkType = '{{ networkType }}'
;

INSERT examples

create_accessor

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.

INSERT INTO aws.managedblockchain.accessors (
ClientRequestToken,
AccessorType,
Tags,
NetworkType,
region
)
SELECT 
'{{ ClientRequestToken }}' /* required */,
'{{ AccessorType }}' /* required */,
'{{ Tags }}',
'{{ NetworkType }}',
'{{ region }}'
RETURNING
accessor_id,
billing_token,
network_type
;

Manifest

# Description fields are for documentation purposes
- name: accessors
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the accessors resource.
  - name: ClientRequestToken
    value: "{{ ClientRequestToken }}"
  - name: AccessorType
    value: "{{ AccessorType }}"
    valid_values: ['BILLING_TOKEN']
  - name: Tags
    value: "{{ Tags }}"
  - name: NetworkType
    value: "{{ NetworkType }}"
    valid_values: ['ETHEREUM_GOERLI', 'ETHEREUM_MAINNET', 'ETHEREUM_MAINNET_AND_GOERLI', 'POLYGON_MAINNET', 'POLYGON_MUMBAI']

DELETE examples

delete_accessor

Deletes an accessor that your Amazon Web Services account owns. An accessor object is a container that has the information required for token based access to your Ethereum nodes including, the BILLING_TOKEN. After an accessor is deleted, the status of the accessor changes from AVAILABLE to PENDING_DELETION. An accessor in the PENDING_DELETION state can’t be used for new WebSocket requests or HTTP requests. However, WebSocket connections that were initiated while the accessor was in the AVAILABLE state remain open until they expire (up to 2 hours).

DELETE FROM aws.managedblockchain.accessors
WHERE accessor_id = '{{ accessor_id }}' --required
AND region = '{{ region }}' --required
;