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

CreateNetwork

Creates a network.

Request Syntax


POST /v1/networks HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "description": "string",
   "networkName": "string",
   "tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

clientToken

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

Type: String

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

Required: No

description

The description of the network.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 100.

Required: No

networkName

The name of the network. You can't change the name after you create the network.

Type: String

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

Pattern: ^[0-9a-zA-Z-]*$

Required: Yes

tags

The tags to apply to the network.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^(?!aws:)[^\x00-\x1f\x22]+$

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Value Pattern: ^[^\x00-\x1f\x22]*$

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "network": { 
      "createdAt": "string",
      "description": "string",
      "networkArn": "string",
      "networkName": "string",
      "status": "string",
      "statusReason": "string"
   },
   "tags": { 
      "string" : "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.

network

Information about the network.

Type: Network object

tags

The network tags.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^(?!aws:)[^\x00-\x1f\x22]+$

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Value Pattern: ^[^\x00-\x1f\x22]*$

Errors

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

InternalServerException

Information about an internal error.

HTTP Status Code: 500

LimitExceededException

The limit was exceeded.

HTTP Status Code: 400

ValidationException

The request failed validation.

HTTP Status Code: 400