Amazon Managed Blockchain
API Reference (API Version 2018-09-24)

CreateNetworkInvitation

Invites another AWS account to create a member on the specified network. The invited AWS account can see the specified network ID using ListInvitedNetworks, and can use GetNetwork on the specified network.

Request Syntax

POST /networks/networkId/invitations HTTP/1.1 Content-type: application/json { "ExpirationDate": number, "InviteeAccountId": "string" }

URI Request Parameters

The request requires the following URI parameters.

NetworkId

The network ID that the AWS account is invited to join.

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

Request Body

The request accepts the following data in JSON format.

ExpirationDate

The latest date and time that the invitation is valid. After this date and time, the invitation is no longer valid.

Type: Timestamp

Required: No

InviteeAccountId

The AWS account to send the invitation to join the network to.

Type: String

Length Constraints: Fixed length of 12.

Pattern: \d+

Required: Yes

Response Syntax

HTTP/1.1 200

Response Elements

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

Errors

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

AccessDeniedException

HTTP Status Code: 403

InternalServiceErrorException

HTTP Status Code: 500

InvalidRequestException

HTTP Status Code: 400

ResourceLimitExceededException

HTTP Status Code: 429

ResourceNotFoundException

HTTP Status Code: 404

ResourceNotReadyException

HTTP Status Code: 409

ThrottlingException

HTTP Status Code: 429

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: