GetNetwork
Gets the specified network.
Request Syntax
GET /v1/networks/networkArn HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- networkArn
-
The Amazon Resource Name (ARN) of the network.
Pattern:
^arn:aws:private-networks:[a-z0-9-]+:[^:]*:.*$Required: Yes
Request Body
The request does not have a request body.
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
-
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
- ResourceNotFoundException
-
The resource was not found.
HTTP Status Code: 404
- ValidationException
-
The request failed validation.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
