Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateAccessor

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.

Request Syntax


POST /accessors HTTP/1.1
Content-type: application/json

{
   "AccessorType": "string",
   "ClientRequestToken": "string",
   "NetworkType": "string",
   "Tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

AccessorType

The type of accessor.

Note

Currently, accessor type is restricted to BILLING_TOKEN.

Type: String

Valid Values: BILLING_TOKEN

Required: Yes

ClientRequestToken

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 AWS SDK or the AWS AWS CLI.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: Yes

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.

Type: String

Valid Values: ETHEREUM_GOERLI | ETHEREUM_MAINNET | ETHEREUM_MAINNET_AND_GOERLI | POLYGON_MAINNET | POLYGON_MUMBAI

Required: No

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.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "AccessorId": "string",
   "BillingToken": "string",
   "NetworkType": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AccessorId

The unique identifier of the accessor.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 32.

BillingToken

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.

Type: String

Length Constraints: Fixed length of 42.

NetworkType

The blockchain network that the accessor token is created for.

Type: String

Valid Values: ETHEREUM_GOERLI | ETHEREUM_MAINNET | ETHEREUM_MAINNET_AND_GOERLI | POLYGON_MAINNET | POLYGON_MUMBAI

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have sufficient access to perform this action.

HTTP Status Code: 403

InternalServiceErrorException

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

InvalidRequestException

The action or operation requested is invalid. Verify that the action is typed correctly.

HTTP Status Code: 400

ResourceAlreadyExistsException

A resource request is issued for a resource that already exists.

HTTP Status Code: 409

ResourceLimitExceededException

The maximum number of resources of that type already exist. Ensure the resources requested are within the boundaries of the service edition and your account limits.

HTTP Status Code: 429

ThrottlingException

The request or operation couldn't be performed because a service is throttling requests. The most common source of throttling errors is creating resources that exceed your service limit for this resource type. Request a limit increase or delete unused resources if possible.

HTTP Status Code: 429

TooManyTagsException

HTTP Status Code: 400