Amazon Managed Blockchain

Creates a new accessor for use with Managed Blockchain Ethereum nodes. 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.create_accessor(
    ClientRequestToken='string',
    AccessorType='BILLING_TOKEN'
)

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.

rtype:

dict

returns:

Response Syntax

{
    'AccessorId': 'string',
    'BillingToken': 'string'
}

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 make Ethereum API calls to your Ethereum node. The billing token is used to track your accessor object for billing Ethereum API requests made to your Ethereum nodes.

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'
)

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.

rtype:

dict

returns:

Response Syntax

{
    'Accessors': [
        {
            'Id': 'string',
            'Type': 'BILLING_TOKEN',
            'Status': 'AVAILABLE'|'PENDING_DELETION'|'DELETED',
            'CreationDate': datetime(2015, 1, 1),
            'Arn': 'string'
        },
    ],
    '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.

      • 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.

  • NextToken (string) --

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

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'
    }
}

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.

    • BillingToken (string) --

      The billing token is a property of the accessor. Use this token to make Ethereum API calls to your Ethereum node. The billing token is used to track your accessor object for billing Ethereum API requests made to your Ethereum nodes.

    • 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.

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 are initiated while the accessor was in the AVAILABLE state remain open until they expire (up to 2 hours).

See also: AWS API Documentation

Request Syntax

client.delete_accessor(
    AccessorId='string'
)

type AccessorId:

string

param AccessorId:

[REQUIRED]

The unique identifier of the accessor.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --