amazonka-managedblockchain-2.0: Amazon Managed Blockchain SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.ManagedBlockChain.CreateAccessor

Description

The token based access feature is in preview release for Ethereum on Amazon Managed Blockchain and is subject to change. We recommend that you use this feature only with test scenarios, and not in production environments.

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.

Synopsis

Creating a Request

data CreateAccessor Source #

See: newCreateAccessor smart constructor.

Constructors

CreateAccessor' 

Fields

  • clientRequestToken :: Text

    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.

  • accessorType :: AccessorType

    The type of accessor.

    Currently accessor type is restricted to BILLING_TOKEN.

Instances

Instances details
ToJSON CreateAccessor Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.CreateAccessor

ToHeaders CreateAccessor Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.CreateAccessor

ToPath CreateAccessor Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.CreateAccessor

ToQuery CreateAccessor Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.CreateAccessor

AWSRequest CreateAccessor Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.CreateAccessor

Associated Types

type AWSResponse CreateAccessor #

Generic CreateAccessor Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.CreateAccessor

Associated Types

type Rep CreateAccessor :: Type -> Type #

Read CreateAccessor Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.CreateAccessor

Show CreateAccessor Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.CreateAccessor

NFData CreateAccessor Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.CreateAccessor

Methods

rnf :: CreateAccessor -> () #

Eq CreateAccessor Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.CreateAccessor

Hashable CreateAccessor Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.CreateAccessor

type AWSResponse CreateAccessor Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.CreateAccessor

type Rep CreateAccessor Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.CreateAccessor

type Rep CreateAccessor = D1 ('MetaData "CreateAccessor" "Amazonka.ManagedBlockChain.CreateAccessor" "amazonka-managedblockchain-2.0-7ETEoTxOH0EDuOBkhEvxdC" 'False) (C1 ('MetaCons "CreateAccessor'" 'PrefixI 'True) (S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "accessorType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AccessorType)))

newCreateAccessor Source #

Create a value of CreateAccessor with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:clientRequestToken:CreateAccessor', createAccessor_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 Amazon Web Services SDK or the Amazon Web Services CLI.

$sel:accessorType:CreateAccessor', createAccessor_accessorType - The type of accessor.

Currently accessor type is restricted to BILLING_TOKEN.

Request Lenses

createAccessor_clientRequestToken :: Lens' CreateAccessor Text Source #

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.

createAccessor_accessorType :: Lens' CreateAccessor AccessorType Source #

The type of accessor.

Currently accessor type is restricted to BILLING_TOKEN.

Destructuring the Response

data CreateAccessorResponse Source #

See: newCreateAccessorResponse smart constructor.

Constructors

CreateAccessorResponse' 

Fields

  • accessorId :: Maybe Text

    The unique identifier of the accessor.

  • billingToken :: Maybe Text

    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.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic CreateAccessorResponse Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.CreateAccessor

Associated Types

type Rep CreateAccessorResponse :: Type -> Type #

Read CreateAccessorResponse Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.CreateAccessor

Show CreateAccessorResponse Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.CreateAccessor

NFData CreateAccessorResponse Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.CreateAccessor

Methods

rnf :: CreateAccessorResponse -> () #

Eq CreateAccessorResponse Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.CreateAccessor

type Rep CreateAccessorResponse Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.CreateAccessor

type Rep CreateAccessorResponse = D1 ('MetaData "CreateAccessorResponse" "Amazonka.ManagedBlockChain.CreateAccessor" "amazonka-managedblockchain-2.0-7ETEoTxOH0EDuOBkhEvxdC" 'False) (C1 ('MetaCons "CreateAccessorResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "accessorId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "billingToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateAccessorResponse Source #

Create a value of CreateAccessorResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:accessorId:CreateAccessorResponse', createAccessorResponse_accessorId - The unique identifier of the accessor.

CreateAccessorResponse, createAccessorResponse_billingToken - 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.

$sel:httpStatus:CreateAccessorResponse', createAccessorResponse_httpStatus - The response's http status code.

Response Lenses

createAccessorResponse_billingToken :: Lens' CreateAccessorResponse (Maybe Text) Source #

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.