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

CreateMember

Creates a member within a Managed Blockchain network.

Applies only to Hyperledger Fabric.

Request Syntax


POST /networks/networkId/members HTTP/1.1
Content-type: application/json

{
   "ClientRequestToken": "string",
   "InvitationId": "string",
   "MemberConfiguration": { 
      "Description": "string",
      "FrameworkConfiguration": { 
         "Fabric": { 
            "AdminPassword": "string",
            "AdminUsername": "string"
         }
      },
      "KmsKeyArn": "string",
      "LogPublishingConfiguration": { 
         "Fabric": { 
            "CaLogs": { 
               "Cloudwatch": { 
                  "Enabled": boolean
               }
            }
         }
      },
      "Name": "string",
      "Tags": { 
         "string" : "string" 
      }
   }
}

URI Request Parameters

The request uses the following URI parameters.

networkId

The unique identifier of the network in which the member is created.

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

ClientRequestToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time. 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 CLI.

Type: String

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

Required: Yes

InvitationId

The unique identifier of the invitation that is sent to the member to join the network.

Type: String

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

Required: Yes

MemberConfiguration

Member configuration parameters.

Type: MemberConfiguration object

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "MemberId": "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.

MemberId

The unique identifier of the member.

Type: String

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

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

ResourceNotFoundException

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

HTTP Status Code: 404

ResourceNotReadyException

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

HTTP Status Code: 409

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