ManagedBlockchain / Client / create_accessor

create_accessor#

ManagedBlockchain.Client.create_accessor(**kwargs)#

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

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

  • ClientRequestToken (string) –

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

  • AccessorType (string) –

    [REQUIRED]

    The type of accessor.

    Note

    Currently, accessor type is restricted to BILLING_TOKEN.

  • Tags (dict) –

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

  • NetworkType (string) –

    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.

Return type:

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.

Exceptions

  • ManagedBlockchain.Client.exceptions.InvalidRequestException

  • ManagedBlockchain.Client.exceptions.AccessDeniedException

  • ManagedBlockchain.Client.exceptions.ResourceAlreadyExistsException

  • ManagedBlockchain.Client.exceptions.ThrottlingException

  • ManagedBlockchain.Client.exceptions.ResourceLimitExceededException

  • ManagedBlockchain.Client.exceptions.InternalServiceErrorException

  • ManagedBlockchain.Client.exceptions.TooManyTagsException