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

UpdateNetworkSite

Updates the specified network site.

Request Syntax


PUT /v1/network-sites/site HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "description": "string",
   "networkSiteArn": "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.

Type: String

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

Required: No

networkSiteArn

The Amazon Resource Name (ARN) of the network site.

Type: String

Pattern: ^arn:aws:private-networks:[a-z0-9-]+:[^:]*:.*$

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "networkSite": { 
      "availabilityZone": "string",
      "availabilityZoneId": "string",
      "createdAt": "string",
      "currentPlan": { 
         "options": [ 
            { 
               "name": "string",
               "value": "string"
            }
         ],
         "resourceDefinitions": [ 
            { 
               "count": number,
               "options": [ 
                  { 
                     "name": "string",
                     "value": "string"
                  }
               ],
               "type": "string"
            }
         ]
      },
      "description": "string",
      "networkArn": "string",
      "networkSiteArn": "string",
      "networkSiteName": "string",
      "pendingPlan": { 
         "options": [ 
            { 
               "name": "string",
               "value": "string"
            }
         ],
         "resourceDefinitions": [ 
            { 
               "count": number,
               "options": [ 
                  { 
                     "name": "string",
                     "value": "string"
                  }
               ],
               "type": "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.

networkSite

Information about the network site.

Type: NetworkSite object

tags

The network site 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

ResourceNotFoundException

The resource was not found.

HTTP Status Code: 404

ValidationException

The request failed validation.

HTTP Status Code: 400