types

package
v1.22.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 29, 2024 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessDeniedException

type AccessDeniedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

func (*AccessDeniedException) Error

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault

func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault

func (*AccessDeniedException) ErrorMessage

func (e *AccessDeniedException) ErrorMessage() string

type Accessor added in v1.13.0

type Accessor struct {

	// The Amazon Resource Name (ARN) of the accessor. For more information about ARNs
	// and their format, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// in the Amazon Web Services General Reference.
	Arn *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.
	BillingToken *string

	// The creation date and time of the accessor.
	CreationDate *time.Time

	// The unique identifier of the accessor.
	Id *string

	// The blockchain network that the Accessor token is created for.
	NetworkType AccessorNetworkType

	// The current status of the accessor.
	Status AccessorStatus

	// The tags assigned to the Accessor. For more information about tags, see Tagging
	// Resources (https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html)
	// in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources (https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html)
	// in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.
	Tags map[string]string

	// The type of the accessor. Currently, accessor type is restricted to
	// BILLING_TOKEN .
	Type AccessorType
	// contains filtered or unexported fields
}

The properties of the Accessor.

type AccessorNetworkType added in v1.19.0

type AccessorNetworkType string
const (
	AccessorNetworkTypeEthereumGoerli           AccessorNetworkType = "ETHEREUM_GOERLI"
	AccessorNetworkTypeEthereumMainnet          AccessorNetworkType = "ETHEREUM_MAINNET"
	AccessorNetworkTypeEthereumMainnetAndGoerli AccessorNetworkType = "ETHEREUM_MAINNET_AND_GOERLI"
	AccessorNetworkTypePolygonMainnet           AccessorNetworkType = "POLYGON_MAINNET"
	AccessorNetworkTypePolygonMumbai            AccessorNetworkType = "POLYGON_MUMBAI"
)

Enum values for AccessorNetworkType

func (AccessorNetworkType) Values added in v1.19.0

Values returns all known values for AccessorNetworkType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AccessorStatus added in v1.13.0

type AccessorStatus string
const (
	AccessorStatusAvailable       AccessorStatus = "AVAILABLE"
	AccessorStatusPendingDeletion AccessorStatus = "PENDING_DELETION"
	AccessorStatusDeleted         AccessorStatus = "DELETED"
)

Enum values for AccessorStatus

func (AccessorStatus) Values added in v1.13.0

func (AccessorStatus) Values() []AccessorStatus

Values returns all known values for AccessorStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AccessorSummary added in v1.13.0

type AccessorSummary struct {

	// The Amazon Resource Name (ARN) of the accessor. For more information about ARNs
	// and their format, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// in the Amazon Web Services General Reference.
	Arn *string

	// The creation date and time of the accessor.
	CreationDate *time.Time

	// The unique identifier of the accessor.
	Id *string

	// The blockchain network that the Accessor token is created for.
	NetworkType AccessorNetworkType

	// The current status of the accessor.
	Status AccessorStatus

	// The type of the accessor. Currently accessor type is restricted to BILLING_TOKEN
	// .
	Type AccessorType
	// contains filtered or unexported fields
}

A summary of accessor properties.

type AccessorType added in v1.13.0

type AccessorType string
const (
	AccessorTypeBillingToken AccessorType = "BILLING_TOKEN"
)

Enum values for AccessorType

func (AccessorType) Values added in v1.13.0

func (AccessorType) Values() []AccessorType

Values returns all known values for AccessorType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ApprovalThresholdPolicy

type ApprovalThresholdPolicy struct {

	// The duration from the time that a proposal is created until it expires. If
	// members cast neither the required number of YES votes to approve the proposal
	// nor the number of NO votes required to reject it before the duration expires,
	// the proposal is EXPIRED and ProposalActions aren't carried out.
	ProposalDurationInHours *int32

	// Determines whether the vote percentage must be greater than the
	// ThresholdPercentage or must be greater than or equal to the ThresholdPercentage
	// to be approved.
	ThresholdComparator ThresholdComparator

	// The percentage of votes among all members that must be YES for a proposal to be
	// approved. For example, a ThresholdPercentage value of 50 indicates 50%. The
	// ThresholdComparator determines the precise comparison. If a ThresholdPercentage
	// value of 50 is specified on a network with 10 members, along with a
	// ThresholdComparator value of GREATER_THAN , this indicates that 6 YES votes are
	// required for the proposal to be approved.
	ThresholdPercentage *int32
	// contains filtered or unexported fields
}

A policy type that defines the voting rules for the network. The rules decide if a proposal is approved. Approval may be based on criteria such as the percentage of YES votes and the duration of the proposal. The policy applies to all proposals and is specified when the network is created. Applies only to Hyperledger Fabric.

type Edition

type Edition string
const (
	EditionStarter  Edition = "STARTER"
	EditionStandard Edition = "STANDARD"
)

Enum values for Edition

func (Edition) Values added in v0.29.0

func (Edition) Values() []Edition

Values returns all known values for Edition. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type Framework

type Framework string
const (
	FrameworkHyperledgerFabric Framework = "HYPERLEDGER_FABRIC"
	FrameworkEthereum          Framework = "ETHEREUM"
)

Enum values for Framework

func (Framework) Values added in v0.29.0

func (Framework) Values() []Framework

Values returns all known values for Framework. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type IllegalActionException

type IllegalActionException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

func (*IllegalActionException) Error

func (e *IllegalActionException) Error() string

func (*IllegalActionException) ErrorCode

func (e *IllegalActionException) ErrorCode() string

func (*IllegalActionException) ErrorFault

func (e *IllegalActionException) ErrorFault() smithy.ErrorFault

func (*IllegalActionException) ErrorMessage

func (e *IllegalActionException) ErrorMessage() string

type InternalServiceErrorException

type InternalServiceErrorException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

func (*InternalServiceErrorException) Error

func (*InternalServiceErrorException) ErrorCode

func (e *InternalServiceErrorException) ErrorCode() string

func (*InternalServiceErrorException) ErrorFault

func (*InternalServiceErrorException) ErrorMessage

func (e *InternalServiceErrorException) ErrorMessage() string

type InvalidRequestException

type InvalidRequestException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

func (*InvalidRequestException) Error

func (e *InvalidRequestException) Error() string

func (*InvalidRequestException) ErrorCode

func (e *InvalidRequestException) ErrorCode() string

func (*InvalidRequestException) ErrorFault

func (e *InvalidRequestException) ErrorFault() smithy.ErrorFault

func (*InvalidRequestException) ErrorMessage

func (e *InvalidRequestException) ErrorMessage() string

type Invitation

type Invitation struct {

	// The Amazon Resource Name (ARN) of the invitation. For more information about
	// ARNs and their format, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// in the Amazon Web Services General Reference.
	Arn *string

	// The date and time that the invitation was created.
	CreationDate *time.Time

	// The date and time that the invitation expires. This is the CreationDate plus
	// the ProposalDurationInHours that is specified in the ProposalThresholdPolicy .
	// After this date and time, the invitee can no longer create a member and join the
	// network using this InvitationId .
	ExpirationDate *time.Time

	// The unique identifier for the invitation.
	InvitationId *string

	// A summary of network configuration properties.
	NetworkSummary *NetworkSummary

	// The status of the invitation:
	//   - PENDING - The invitee hasn't created a member to join the network, and the
	//   invitation hasn't yet expired.
	//   - ACCEPTING - The invitee has begun creating a member, and creation hasn't yet
	//   completed.
	//   - ACCEPTED - The invitee created a member and joined the network using the
	//   InvitationID .
	//   - REJECTED - The invitee rejected the invitation.
	//   - EXPIRED - The invitee neither created a member nor rejected the invitation
	//   before the ExpirationDate .
	Status InvitationStatus
	// contains filtered or unexported fields
}

An invitation to an Amazon Web Services account to create a member and join the network. Applies only to Hyperledger Fabric.

type InvitationStatus

type InvitationStatus string
const (
	InvitationStatusPending   InvitationStatus = "PENDING"
	InvitationStatusAccepted  InvitationStatus = "ACCEPTED"
	InvitationStatusAccepting InvitationStatus = "ACCEPTING"
	InvitationStatusRejected  InvitationStatus = "REJECTED"
	InvitationStatusExpired   InvitationStatus = "EXPIRED"
)

Enum values for InvitationStatus

func (InvitationStatus) Values added in v0.29.0

Values returns all known values for InvitationStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type InviteAction

type InviteAction struct {

	// The Amazon Web Services account ID to invite.
	//
	// This member is required.
	Principal *string
	// contains filtered or unexported fields
}

An action to invite a specific Amazon Web Services account to create a member and join the network. The InviteAction is carried out when a Proposal is APPROVED . Applies only to Hyperledger Fabric.

type LogConfiguration

type LogConfiguration struct {

	// Indicates whether logging is enabled.
	Enabled *bool
	// contains filtered or unexported fields
}

A configuration for logging events.

type LogConfigurations

type LogConfigurations struct {

	// Parameters for publishing logs to Amazon CloudWatch Logs.
	Cloudwatch *LogConfiguration
	// contains filtered or unexported fields
}

A collection of log configurations.

type Member

type Member struct {

	// The Amazon Resource Name (ARN) of the member. For more information about ARNs
	// and their format, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// in the Amazon Web Services General Reference.
	Arn *string

	// The date and time that the member was created.
	CreationDate *time.Time

	// An optional description for the member.
	Description *string

	// Attributes relevant to a member for the blockchain framework that the Managed
	// Blockchain network uses.
	FrameworkAttributes *MemberFrameworkAttributes

	// The unique identifier of the member.
	Id *string

	// The Amazon Resource Name (ARN) of the customer managed key in Key Management
	// Service (KMS) that the member uses for encryption at rest. If the value of this
	// parameter is "AWS Owned KMS Key" , the member uses an Amazon Web Services owned
	// KMS key for encryption. This parameter is inherited by the nodes that this
	// member owns. For more information, see Encryption at Rest (https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/managed-blockchain-encryption-at-rest.html)
	// in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.
	KmsKeyArn *string

	// Configuration properties for logging events associated with a member.
	LogPublishingConfiguration *MemberLogPublishingConfiguration

	// The name of the member.
	Name *string

	// The unique identifier of the network to which the member belongs.
	NetworkId *string

	// The status of a member.
	//   - CREATING - The Amazon Web Services account is in the process of creating a
	//   member.
	//   - AVAILABLE - The member has been created and can participate in the network.
	//   - CREATE_FAILED - The Amazon Web Services account attempted to create a member
	//   and creation failed.
	//   - UPDATING - The member is in the process of being updated.
	//   - DELETING - The member and all associated resources are in the process of
	//   being deleted. Either the Amazon Web Services account that owns the member
	//   deleted it, or the member is being deleted as the result of an APPROVED
	//   PROPOSAL to remove the member.
	//   - DELETED - The member can no longer participate on the network and all
	//   associated resources are deleted. Either the Amazon Web Services account that
	//   owns the member deleted it, or the member is being deleted as the result of an
	//   APPROVED PROPOSAL to remove the member.
	//   - INACCESSIBLE_ENCRYPTION_KEY - The member is impaired and might not function
	//   as expected because it cannot access the specified customer managed key in KMS
	//   for encryption at rest. Either the KMS key was disabled or deleted, or the
	//   grants on the key were revoked. The effect of disabling or deleting a key or of
	//   revoking a grant isn't immediate. It might take some time for the member
	//   resource to discover that the key is inaccessible. When a resource is in this
	//   state, we recommend deleting and recreating the resource.
	Status MemberStatus

	// Tags assigned to the member. Tags consist of a key and optional value. For more
	// information about tags, see Tagging Resources (https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html)
	// in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources (https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html)
	// in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.
	Tags map[string]string
	// contains filtered or unexported fields
}

Member configuration properties. Applies only to Hyperledger Fabric.

type MemberConfiguration

type MemberConfiguration struct {

	// Configuration properties of the blockchain framework relevant to the member.
	//
	// This member is required.
	FrameworkConfiguration *MemberFrameworkConfiguration

	// The name of the member.
	//
	// This member is required.
	Name *string

	// An optional description of the member.
	Description *string

	// The Amazon Resource Name (ARN) of the customer managed key in Key Management
	// Service (KMS) to use for encryption at rest in the member. This parameter is
	// inherited by any nodes that this member creates. For more information, see
	// Encryption at Rest (https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/managed-blockchain-encryption-at-rest.html)
	// in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide. Use one of
	// the following options to specify this parameter:
	//   - Undefined or empty string - By default, use an KMS key that is owned and
	//   managed by Amazon Web Services on your behalf.
	//   - A valid symmetric customer managed KMS key - Use the specified KMS key in
	//   your account that you create, own, and manage. Amazon Managed Blockchain doesn't
	//   support asymmetric keys. For more information, see Using symmetric and
	//   asymmetric keys (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html)
	//   in the Key Management Service Developer Guide. The following is an example of a
	//   KMS key ARN:
	//   arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
	KmsKeyArn *string

	// Configuration properties for logging events associated with a member of a
	// Managed Blockchain network.
	LogPublishingConfiguration *MemberLogPublishingConfiguration

	// Tags assigned to the member. Tags consist of a key and optional value. When
	// specifying tags during creation, you can specify multiple key-value pairs in a
	// single request, with an overall maximum of 50 tags added to each resource. For
	// more information about tags, see Tagging Resources (https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html)
	// in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources (https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html)
	// in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.
	Tags map[string]string
	// contains filtered or unexported fields
}

Configuration properties of the member. Applies only to Hyperledger Fabric.

type MemberFabricAttributes

type MemberFabricAttributes struct {

	// The user name for the initial administrator user for the member.
	AdminUsername *string

	// The endpoint used to access the member's certificate authority.
	CaEndpoint *string
	// contains filtered or unexported fields
}

Attributes of Hyperledger Fabric for a member in a Managed Blockchain network using the Hyperledger Fabric framework.

type MemberFabricConfiguration

type MemberFabricConfiguration struct {

	// The password for the member's initial administrative user. The AdminPassword
	// must be at least 8 characters long and no more than 32 characters. It must
	// contain at least one uppercase letter, one lowercase letter, and one digit. It
	// cannot have a single quotation mark (‘), a double quotation marks (“), a forward
	// slash(/), a backward slash(\), @, or a space.
	//
	// This member is required.
	AdminPassword *string

	// The user name for the member's initial administrative user.
	//
	// This member is required.
	AdminUsername *string
	// contains filtered or unexported fields
}

Configuration properties for Hyperledger Fabric for a member in a Managed Blockchain network that is using the Hyperledger Fabric framework.

type MemberFabricLogPublishingConfiguration

type MemberFabricLogPublishingConfiguration struct {

	// Configuration properties for logging events associated with a member's
	// Certificate Authority (CA). CA logs help you determine when a member in your
	// account joins the network, or when new peers register with a member CA.
	CaLogs *LogConfigurations
	// contains filtered or unexported fields
}

Configuration properties for logging events associated with a member of a Managed Blockchain network using the Hyperledger Fabric framework.

type MemberFrameworkAttributes

type MemberFrameworkAttributes struct {

	// Attributes of Hyperledger Fabric relevant to a member on a Managed Blockchain
	// network that uses Hyperledger Fabric.
	Fabric *MemberFabricAttributes
	// contains filtered or unexported fields
}

Attributes relevant to a member for the blockchain framework that the Managed Blockchain network uses.

type MemberFrameworkConfiguration

type MemberFrameworkConfiguration struct {

	// Attributes of Hyperledger Fabric for a member on a Managed Blockchain network
	// that uses Hyperledger Fabric.
	Fabric *MemberFabricConfiguration
	// contains filtered or unexported fields
}

Configuration properties relevant to a member for the blockchain framework that the Managed Blockchain network uses.

type MemberLogPublishingConfiguration

type MemberLogPublishingConfiguration struct {

	// Configuration properties for logging events associated with a member of a
	// Managed Blockchain network using the Hyperledger Fabric framework.
	Fabric *MemberFabricLogPublishingConfiguration
	// contains filtered or unexported fields
}

Configuration properties for logging events associated with a member of a Managed Blockchain network.

type MemberStatus

type MemberStatus string
const (
	MemberStatusCreating                  MemberStatus = "CREATING"
	MemberStatusAvailable                 MemberStatus = "AVAILABLE"
	MemberStatusCreateFailed              MemberStatus = "CREATE_FAILED"
	MemberStatusUpdating                  MemberStatus = "UPDATING"
	MemberStatusDeleting                  MemberStatus = "DELETING"
	MemberStatusDeleted                   MemberStatus = "DELETED"
	MemberStatusInaccessibleEncryptionKey MemberStatus = "INACCESSIBLE_ENCRYPTION_KEY"
)

Enum values for MemberStatus

func (MemberStatus) Values added in v0.29.0

func (MemberStatus) Values() []MemberStatus

Values returns all known values for MemberStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type MemberSummary

type MemberSummary struct {

	// The Amazon Resource Name (ARN) of the member. For more information about ARNs
	// and their format, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// in the Amazon Web Services General Reference.
	Arn *string

	// The date and time that the member was created.
	CreationDate *time.Time

	// An optional description of the member.
	Description *string

	// The unique identifier of the member.
	Id *string

	// An indicator of whether the member is owned by your Amazon Web Services account
	// or a different Amazon Web Services account.
	IsOwned *bool

	// The name of the member.
	Name *string

	// The status of the member.
	//   - CREATING - The Amazon Web Services account is in the process of creating a
	//   member.
	//   - AVAILABLE - The member has been created and can participate in the network.
	//   - CREATE_FAILED - The Amazon Web Services account attempted to create a member
	//   and creation failed.
	//   - UPDATING - The member is in the process of being updated.
	//   - DELETING - The member and all associated resources are in the process of
	//   being deleted. Either the Amazon Web Services account that owns the member
	//   deleted it, or the member is being deleted as the result of an APPROVED
	//   PROPOSAL to remove the member.
	//   - DELETED - The member can no longer participate on the network and all
	//   associated resources are deleted. Either the Amazon Web Services account that
	//   owns the member deleted it, or the member is being deleted as the result of an
	//   APPROVED PROPOSAL to remove the member.
	//   - INACCESSIBLE_ENCRYPTION_KEY - The member is impaired and might not function
	//   as expected because it cannot access the specified customer managed key in Key
	//   Management Service (KMS) for encryption at rest. Either the KMS key was disabled
	//   or deleted, or the grants on the key were revoked. The effect of disabling or
	//   deleting a key or of revoking a grant isn't immediate. It might take some time
	//   for the member resource to discover that the key is inaccessible. When a
	//   resource is in this state, we recommend deleting and recreating the resource.
	Status MemberStatus
	// contains filtered or unexported fields
}

A summary of configuration properties for a member. Applies only to Hyperledger Fabric.

type Network

type Network struct {

	// The Amazon Resource Name (ARN) of the network. For more information about ARNs
	// and their format, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// in the Amazon Web Services General Reference.
	Arn *string

	// The date and time that the network was created.
	CreationDate *time.Time

	// Attributes of the blockchain framework for the network.
	Description *string

	// The blockchain framework that the network uses.
	Framework Framework

	// Attributes of the blockchain framework that the network uses.
	FrameworkAttributes *NetworkFrameworkAttributes

	// The version of the blockchain framework that the network uses.
	FrameworkVersion *string

	// The unique identifier of the network.
	Id *string

	// The name of the network.
	Name *string

	// The current status of the network.
	Status NetworkStatus

	// Tags assigned to the network. Each tag consists of a key and optional value.
	// For more information about tags, see Tagging Resources (https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html)
	// in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources (https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html)
	// in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.
	Tags map[string]string

	// The voting rules that the network uses to decide if a proposal is accepted.
	VotingPolicy *VotingPolicy

	// The VPC endpoint service name of the VPC endpoint service of the network.
	// Members use the VPC endpoint service name to create a VPC endpoint to access
	// network resources.
	VpcEndpointServiceName *string
	// contains filtered or unexported fields
}

Network configuration properties.

type NetworkEthereumAttributes added in v0.31.0

type NetworkEthereumAttributes struct {

	// The Ethereum CHAIN_ID associated with the Ethereum network. Chain IDs are as
	// follows:
	//   - mainnet = 1
	//   - goerli = 5
	ChainId *string
	// contains filtered or unexported fields
}

Attributes of Ethereum for a network.

type NetworkFabricAttributes

type NetworkFabricAttributes struct {

	// The edition of Amazon Managed Blockchain that Hyperledger Fabric uses. For more
	// information, see Amazon Managed Blockchain Pricing (http://aws.amazon.com/managed-blockchain/pricing/)
	// .
	Edition Edition

	// The endpoint of the ordering service for the network.
	OrderingServiceEndpoint *string
	// contains filtered or unexported fields
}

Attributes of Hyperledger Fabric for a network.

type NetworkFabricConfiguration

type NetworkFabricConfiguration struct {

	// The edition of Amazon Managed Blockchain that the network uses. For more
	// information, see Amazon Managed Blockchain Pricing (http://aws.amazon.com/managed-blockchain/pricing/)
	// .
	//
	// This member is required.
	Edition Edition
	// contains filtered or unexported fields
}

Hyperledger Fabric configuration properties for the network.

type NetworkFrameworkAttributes

type NetworkFrameworkAttributes struct {

	// Attributes of an Ethereum network for Managed Blockchain resources
	// participating in an Ethereum network.
	Ethereum *NetworkEthereumAttributes

	// Attributes of Hyperledger Fabric for a Managed Blockchain network that uses
	// Hyperledger Fabric.
	Fabric *NetworkFabricAttributes
	// contains filtered or unexported fields
}

Attributes relevant to the network for the blockchain framework that the network uses.

type NetworkFrameworkConfiguration

type NetworkFrameworkConfiguration struct {

	// Hyperledger Fabric configuration properties for a Managed Blockchain network
	// that uses Hyperledger Fabric.
	Fabric *NetworkFabricConfiguration
	// contains filtered or unexported fields
}

Configuration properties relevant to the network for the blockchain framework that the network uses.

type NetworkStatus

type NetworkStatus string
const (
	NetworkStatusCreating     NetworkStatus = "CREATING"
	NetworkStatusAvailable    NetworkStatus = "AVAILABLE"
	NetworkStatusCreateFailed NetworkStatus = "CREATE_FAILED"
	NetworkStatusDeleting     NetworkStatus = "DELETING"
	NetworkStatusDeleted      NetworkStatus = "DELETED"
)

Enum values for NetworkStatus

func (NetworkStatus) Values added in v0.29.0

func (NetworkStatus) Values() []NetworkStatus

Values returns all known values for NetworkStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type NetworkSummary

type NetworkSummary struct {

	// The Amazon Resource Name (ARN) of the network. For more information about ARNs
	// and their format, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// in the Amazon Web Services General Reference.
	Arn *string

	// The date and time that the network was created.
	CreationDate *time.Time

	// An optional description of the network.
	Description *string

	// The blockchain framework that the network uses.
	Framework Framework

	// The version of the blockchain framework that the network uses.
	FrameworkVersion *string

	// The unique identifier of the network.
	Id *string

	// The name of the network.
	Name *string

	// The current status of the network.
	Status NetworkStatus
	// contains filtered or unexported fields
}

A summary of network configuration properties.

type Node

type Node struct {

	// The Amazon Resource Name (ARN) of the node. For more information about ARNs and
	// their format, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// in the Amazon Web Services General Reference.
	Arn *string

	// The Availability Zone in which the node exists. Required for Ethereum nodes.
	AvailabilityZone *string

	// The date and time that the node was created.
	CreationDate *time.Time

	// Attributes of the blockchain framework being used.
	FrameworkAttributes *NodeFrameworkAttributes

	// The unique identifier of the node.
	Id *string

	// The instance type of the node.
	InstanceType *string

	// The Amazon Resource Name (ARN) of the customer managed key in Key Management
	// Service (KMS) that the node uses for encryption at rest. If the value of this
	// parameter is "AWS Owned KMS Key" , the node uses an Amazon Web Services owned
	// KMS key for encryption. The node inherits this parameter from the member that it
	// belongs to. For more information, see Encryption at Rest (https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/managed-blockchain-encryption-at-rest.html)
	// in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide. Applies
	// only to Hyperledger Fabric.
	KmsKeyArn *string

	// Configuration properties for logging events associated with a peer node on a
	// Hyperledger Fabric network on Managed Blockchain.
	LogPublishingConfiguration *NodeLogPublishingConfiguration

	// The unique identifier of the member to which the node belongs. Applies only to
	// Hyperledger Fabric.
	MemberId *string

	// The unique identifier of the network that the node is on.
	NetworkId *string

	// The state database that the node uses. Values are LevelDB or CouchDB . Applies
	// only to Hyperledger Fabric.
	StateDB StateDBType

	// The status of the node.
	//   - CREATING - The Amazon Web Services account is in the process of creating a
	//   node.
	//   - AVAILABLE - The node has been created and can participate in the network.
	//   - UNHEALTHY - The node is impaired and might not function as expected. Amazon
	//   Managed Blockchain automatically finds nodes in this state and tries to recover
	//   them. If a node is recoverable, it returns to AVAILABLE . Otherwise, it moves
	//   to FAILED status.
	//   - CREATE_FAILED - The Amazon Web Services account attempted to create a node
	//   and creation failed.
	//   - UPDATING - The node is in the process of being updated.
	//   - DELETING - The node is in the process of being deleted.
	//   - DELETED - The node can no longer participate on the network.
	//   - FAILED - The node is no longer functional, cannot be recovered, and must be
	//   deleted.
	//   - INACCESSIBLE_ENCRYPTION_KEY - The node is impaired and might not function as
	//   expected because it cannot access the specified customer managed key in KMS for
	//   encryption at rest. Either the KMS key was disabled or deleted, or the grants on
	//   the key were revoked. The effect of disabling or deleting a key or of revoking a
	//   grant isn't immediate. It might take some time for the node resource to discover
	//   that the key is inaccessible. When a resource is in this state, we recommend
	//   deleting and recreating the resource.
	Status NodeStatus

	// Tags assigned to the node. Each tag consists of a key and optional value. For
	// more information about tags, see Tagging Resources (https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html)
	// in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources (https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html)
	// in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.
	Tags map[string]string
	// contains filtered or unexported fields
}

Configuration properties of a node.

type NodeConfiguration

type NodeConfiguration struct {

	// The Amazon Managed Blockchain instance type for the node.
	//
	// This member is required.
	InstanceType *string

	// The Availability Zone in which the node exists. Required for Ethereum nodes.
	AvailabilityZone *string

	// Configuration properties for logging events associated with a peer node on a
	// Hyperledger Fabric network on Managed Blockchain.
	LogPublishingConfiguration *NodeLogPublishingConfiguration

	// The state database that the node uses. Values are LevelDB or CouchDB . When
	// using an Amazon Managed Blockchain network with Hyperledger Fabric version 1.4
	// or later, the default is CouchDB . Applies only to Hyperledger Fabric.
	StateDB StateDBType
	// contains filtered or unexported fields
}

Configuration properties of a node.

type NodeEthereumAttributes added in v0.31.0

type NodeEthereumAttributes struct {

	// The endpoint on which the Ethereum node listens to run Ethereum API methods
	// over HTTP connections from a client. Use this endpoint in client code for smart
	// contracts when using an HTTP connection. Connections to this endpoint are
	// authenticated using Signature Version 4 (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html)
	// .
	HttpEndpoint *string

	// The endpoint on which the Ethereum node listens to run Ethereum JSON-RPC
	// methods over WebSocket connections from a client. Use this endpoint in client
	// code for smart contracts when using a WebSocket connection. Connections to this
	// endpoint are authenticated using Signature Version 4 (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html)
	// .
	WebSocketEndpoint *string
	// contains filtered or unexported fields
}

Attributes of an Ethereum node.

type NodeFabricAttributes

type NodeFabricAttributes struct {

	// The endpoint that identifies the peer node for all services except peer
	// channel-based event services.
	PeerEndpoint *string

	// The endpoint that identifies the peer node for peer channel-based event
	// services.
	PeerEventEndpoint *string
	// contains filtered or unexported fields
}

Attributes of Hyperledger Fabric for a peer node on a Hyperledger Fabric network on Managed Blockchain.

type NodeFabricLogPublishingConfiguration

type NodeFabricLogPublishingConfiguration struct {

	// Configuration properties for logging events associated with chaincode execution
	// on a peer node. Chaincode logs contain the results of instantiating, invoking,
	// and querying the chaincode. A peer can run multiple instances of chaincode. When
	// enabled, a log stream is created for all chaincodes, with an individual log
	// stream for each chaincode.
	ChaincodeLogs *LogConfigurations

	// Configuration properties for a peer node log. Peer node logs contain messages
	// generated when your client submits transaction proposals to peer nodes, requests
	// to join channels, enrolls an admin peer, and lists the chaincode instances on a
	// peer node.
	PeerLogs *LogConfigurations
	// contains filtered or unexported fields
}

Configuration properties for logging events associated with a peer node owned by a member in a Managed Blockchain network.

type NodeFrameworkAttributes

type NodeFrameworkAttributes struct {

	// Attributes of Ethereum for a node on a Managed Blockchain network that uses
	// Ethereum.
	Ethereum *NodeEthereumAttributes

	// Attributes of Hyperledger Fabric for a peer node on a Managed Blockchain
	// network that uses Hyperledger Fabric.
	Fabric *NodeFabricAttributes
	// contains filtered or unexported fields
}

Attributes relevant to a node on a Managed Blockchain network for the blockchain framework that the network uses.

type NodeLogPublishingConfiguration

type NodeLogPublishingConfiguration struct {

	// Configuration properties for logging events associated with a node that is
	// owned by a member of a Managed Blockchain network using the Hyperledger Fabric
	// framework.
	Fabric *NodeFabricLogPublishingConfiguration
	// contains filtered or unexported fields
}

Configuration properties for logging events associated with a peer node on a Hyperledger Fabric network on Managed Blockchain.

type NodeStatus

type NodeStatus string
const (
	NodeStatusCreating                  NodeStatus = "CREATING"
	NodeStatusAvailable                 NodeStatus = "AVAILABLE"
	NodeStatusUnhealthy                 NodeStatus = "UNHEALTHY"
	NodeStatusCreateFailed              NodeStatus = "CREATE_FAILED"
	NodeStatusUpdating                  NodeStatus = "UPDATING"
	NodeStatusDeleting                  NodeStatus = "DELETING"
	NodeStatusDeleted                   NodeStatus = "DELETED"
	NodeStatusFailed                    NodeStatus = "FAILED"
	NodeStatusInaccessibleEncryptionKey NodeStatus = "INACCESSIBLE_ENCRYPTION_KEY"
)

Enum values for NodeStatus

func (NodeStatus) Values added in v0.29.0

func (NodeStatus) Values() []NodeStatus

Values returns all known values for NodeStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type NodeSummary

type NodeSummary struct {

	// The Amazon Resource Name (ARN) of the node. For more information about ARNs and
	// their format, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// in the Amazon Web Services General Reference.
	Arn *string

	// The Availability Zone in which the node exists.
	AvailabilityZone *string

	// The date and time that the node was created.
	CreationDate *time.Time

	// The unique identifier of the node.
	Id *string

	// The EC2 instance type for the node.
	InstanceType *string

	// The status of the node.
	Status NodeStatus
	// contains filtered or unexported fields
}

A summary of configuration properties for a node.

type Proposal

type Proposal struct {

	// The actions to perform on the network if the proposal is APPROVED .
	Actions *ProposalActions

	// The Amazon Resource Name (ARN) of the proposal. For more information about ARNs
	// and their format, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// in the Amazon Web Services General Reference.
	Arn *string

	// The date and time that the proposal was created.
	CreationDate *time.Time

	// The description of the proposal.
	Description *string

	// The date and time that the proposal expires. This is the CreationDate plus the
	// ProposalDurationInHours that is specified in the ProposalThresholdPolicy . After
	// this date and time, if members haven't cast enough votes to determine the
	// outcome according to the voting policy, the proposal is EXPIRED and Actions
	// aren't carried out.
	ExpirationDate *time.Time

	// The unique identifier of the network for which the proposal is made.
	NetworkId *string

	// The current total of NO votes cast on the proposal by members.
	NoVoteCount *int32

	// The number of votes remaining to be cast on the proposal by members. In other
	// words, the number of members minus the sum of YES votes and NO votes.
	OutstandingVoteCount *int32

	// The unique identifier of the proposal.
	ProposalId *string

	// The unique identifier of the member that created the proposal.
	ProposedByMemberId *string

	// The name of the member that created the proposal.
	ProposedByMemberName *string

	// The status of the proposal. Values are as follows:
	//   - IN_PROGRESS - The proposal is active and open for member voting.
	//   - APPROVED - The proposal was approved with sufficient YES votes among members
	//   according to the VotingPolicy specified for the Network . The specified
	//   proposal actions are carried out.
	//   - REJECTED - The proposal was rejected with insufficient YES votes among
	//   members according to the VotingPolicy specified for the Network . The
	//   specified ProposalActions aren't carried out.
	//   - EXPIRED - Members didn't cast the number of votes required to determine the
	//   proposal outcome before the proposal expired. The specified ProposalActions
	//   aren't carried out.
	//   - ACTION_FAILED - One or more of the specified ProposalActions in a proposal
	//   that was approved couldn't be completed because of an error. The ACTION_FAILED
	//   status occurs even if only one ProposalAction fails and other actions are
	//   successful.
	Status ProposalStatus

	// Tags assigned to the proposal. Each tag consists of a key and optional value.
	// For more information about tags, see Tagging Resources (https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html)
	// in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources (https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html)
	// in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.
	Tags map[string]string

	// The current total of YES votes cast on the proposal by members.
	YesVoteCount *int32
	// contains filtered or unexported fields
}

Properties of a proposal on a Managed Blockchain network. Applies only to Hyperledger Fabric.

type ProposalActions

type ProposalActions struct {

	// The actions to perform for an APPROVED proposal to invite an Amazon Web
	// Services account to create a member and join the network.
	Invitations []InviteAction

	// The actions to perform for an APPROVED proposal to remove a member from the
	// network, which deletes the member and all associated member resources from the
	// network.
	Removals []RemoveAction
	// contains filtered or unexported fields
}

The actions to carry out if a proposal is APPROVED . Applies only to Hyperledger Fabric.

type ProposalStatus

type ProposalStatus string
const (
	ProposalStatusInProgress   ProposalStatus = "IN_PROGRESS"
	ProposalStatusApproved     ProposalStatus = "APPROVED"
	ProposalStatusRejected     ProposalStatus = "REJECTED"
	ProposalStatusExpired      ProposalStatus = "EXPIRED"
	ProposalStatusActionFailed ProposalStatus = "ACTION_FAILED"
)

Enum values for ProposalStatus

func (ProposalStatus) Values added in v0.29.0

func (ProposalStatus) Values() []ProposalStatus

Values returns all known values for ProposalStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ProposalSummary

type ProposalSummary struct {

	// The Amazon Resource Name (ARN) of the proposal. For more information about ARNs
	// and their format, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// in the Amazon Web Services General Reference.
	Arn *string

	// The date and time that the proposal was created.
	CreationDate *time.Time

	// The description of the proposal.
	Description *string

	// The date and time that the proposal expires. This is the CreationDate plus the
	// ProposalDurationInHours that is specified in the ProposalThresholdPolicy . After
	// this date and time, if members haven't cast enough votes to determine the
	// outcome according to the voting policy, the proposal is EXPIRED and Actions
	// aren't carried out.
	ExpirationDate *time.Time

	// The unique identifier of the proposal.
	ProposalId *string

	// The unique identifier of the member that created the proposal.
	ProposedByMemberId *string

	// The name of the member that created the proposal.
	ProposedByMemberName *string

	// The status of the proposal. Values are as follows:
	//   - IN_PROGRESS - The proposal is active and open for member voting.
	//   - APPROVED - The proposal was approved with sufficient YES votes among members
	//   according to the VotingPolicy specified for the Network . The specified
	//   proposal actions are carried out.
	//   - REJECTED - The proposal was rejected with insufficient YES votes among
	//   members according to the VotingPolicy specified for the Network . The
	//   specified ProposalActions aren't carried out.
	//   - EXPIRED - Members didn't cast the number of votes required to determine the
	//   proposal outcome before the proposal expired. The specified ProposalActions
	//   aren't carried out.
	//   - ACTION_FAILED - One or more of the specified ProposalActions in a proposal
	//   that was approved couldn't be completed because of an error.
	Status ProposalStatus
	// contains filtered or unexported fields
}

Properties of a proposal. Applies only to Hyperledger Fabric.

type RemoveAction

type RemoveAction struct {

	// The unique identifier of the member to remove.
	//
	// This member is required.
	MemberId *string
	// contains filtered or unexported fields
}

An action to remove a member from a Managed Blockchain network as the result of a removal proposal that is APPROVED . The member and all associated resources are deleted from the network. Applies only to Hyperledger Fabric.

type ResourceAlreadyExistsException

type ResourceAlreadyExistsException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

func (*ResourceAlreadyExistsException) Error

func (*ResourceAlreadyExistsException) ErrorCode

func (e *ResourceAlreadyExistsException) ErrorCode() string

func (*ResourceAlreadyExistsException) ErrorFault

func (*ResourceAlreadyExistsException) ErrorMessage

func (e *ResourceAlreadyExistsException) ErrorMessage() string

type ResourceLimitExceededException

type ResourceLimitExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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.

func (*ResourceLimitExceededException) Error

func (*ResourceLimitExceededException) ErrorCode

func (e *ResourceLimitExceededException) ErrorCode() string

func (*ResourceLimitExceededException) ErrorFault

func (*ResourceLimitExceededException) ErrorMessage

func (e *ResourceLimitExceededException) ErrorMessage() string

type ResourceNotFoundException

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceName *string
	// contains filtered or unexported fields
}

A requested resource doesn't exist. It may have been deleted or referenced incorrectly.

func (*ResourceNotFoundException) Error

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault

func (*ResourceNotFoundException) ErrorMessage

func (e *ResourceNotFoundException) ErrorMessage() string

type ResourceNotReadyException

type ResourceNotReadyException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The requested resource exists but isn't in a status that can complete the operation.

func (*ResourceNotReadyException) Error

func (e *ResourceNotReadyException) Error() string

func (*ResourceNotReadyException) ErrorCode

func (e *ResourceNotReadyException) ErrorCode() string

func (*ResourceNotReadyException) ErrorFault

func (*ResourceNotReadyException) ErrorMessage

func (e *ResourceNotReadyException) ErrorMessage() string

type StateDBType added in v0.29.0

type StateDBType string
const (
	StateDBTypeLevelDB StateDBType = "LevelDB"
	StateDBTypeCouchDB StateDBType = "CouchDB"
)

Enum values for StateDBType

func (StateDBType) Values added in v0.29.0

func (StateDBType) Values() []StateDBType

Values returns all known values for StateDBType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ThresholdComparator

type ThresholdComparator string
const (
	ThresholdComparatorGreaterThan          ThresholdComparator = "GREATER_THAN"
	ThresholdComparatorGreaterThanOrEqualTo ThresholdComparator = "GREATER_THAN_OR_EQUAL_TO"
)

Enum values for ThresholdComparator

func (ThresholdComparator) Values added in v0.29.0

Values returns all known values for ThresholdComparator. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ThrottlingException

type ThrottlingException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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.

func (*ThrottlingException) Error

func (e *ThrottlingException) Error() string

func (*ThrottlingException) ErrorCode

func (e *ThrottlingException) ErrorCode() string

func (*ThrottlingException) ErrorFault

func (e *ThrottlingException) ErrorFault() smithy.ErrorFault

func (*ThrottlingException) ErrorMessage

func (e *ThrottlingException) ErrorMessage() string

type TooManyTagsException added in v1.2.0

type TooManyTagsException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceName *string
	// contains filtered or unexported fields
}

func (*TooManyTagsException) Error added in v1.2.0

func (e *TooManyTagsException) Error() string

func (*TooManyTagsException) ErrorCode added in v1.2.0

func (e *TooManyTagsException) ErrorCode() string

func (*TooManyTagsException) ErrorFault added in v1.2.0

func (e *TooManyTagsException) ErrorFault() smithy.ErrorFault

func (*TooManyTagsException) ErrorMessage added in v1.2.0

func (e *TooManyTagsException) ErrorMessage() string

type VoteSummary

type VoteSummary struct {

	// The unique identifier of the member that cast the vote.
	MemberId *string

	// The name of the member that cast the vote.
	MemberName *string

	// The vote value, either YES or NO .
	Vote VoteValue
	// contains filtered or unexported fields
}

Properties of an individual vote that a member cast for a proposal. Applies only to Hyperledger Fabric.

type VoteValue

type VoteValue string
const (
	VoteValueYes VoteValue = "YES"
	VoteValueNo  VoteValue = "NO"
)

Enum values for VoteValue

func (VoteValue) Values added in v0.29.0

func (VoteValue) Values() []VoteValue

Values returns all known values for VoteValue. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type VotingPolicy

type VotingPolicy struct {

	// Defines the rules for the network for voting on proposals, such as the
	// percentage of YES votes required for the proposal to be approved and the
	// duration of the proposal. The policy applies to all proposals and is specified
	// when the network is created.
	ApprovalThresholdPolicy *ApprovalThresholdPolicy
	// contains filtered or unexported fields
}

The voting rules for the network to decide if a proposal is accepted Applies only to Hyperledger Fabric.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL