UpdateCoreNetwork - AWS Global Networks for Transit Gateways


Updates the description of a core network.

Request Syntax

PATCH /core-networks/coreNetworkId HTTP/1.1 Content-type: application/json { "Description": "string" }

URI Request Parameters

The request uses the following URI parameters.


The ID of a core network.

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

Pattern: ^core-network-([0-9a-f]{8,17})$

Required: Yes

Request Body

The request accepts the following data in JSON format.


The description of the update.

Type: String

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

Pattern: [\s\S]*

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "CoreNetwork": { "CoreNetworkArn": "string", "CoreNetworkId": "string", "CreatedAt": number, "Description": "string", "Edges": [ { "Asn": number, "EdgeLocation": "string", "InsideCidrBlocks": [ "string" ] } ], "GlobalNetworkId": "string", "Segments": [ { "EdgeLocations": [ "string" ], "Name": "string", "SharedSegments": [ "string" ] } ], "State": "string", "Tags": [ { "Key": "string", "Value": "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.


Returns information about a core network update.

Type: CoreNetwork object


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


You do not have sufficient access to perform this action.

HTTP Status Code: 403


There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

HTTP Status Code: 409


The request has failed due to an internal error.

HTTP Status Code: 500


The specified resource could not be found.

HTTP Status Code: 404


The request was denied due to request throttling.

HTTP Status Code: 429


The input fails to satisfy the constraints.

HTTP Status Code: 400

See Also

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