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

GetNetworkResource

Gets the specified network resource.

Request Syntax


GET /v1/network-resources/networkResourceArn HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

networkResourceArn

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

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

{
   "networkResource": { 
      "attributes": [ 
         { 
            "name": "string",
            "value": "string"
         }
      ],
      "commitmentInformation": { 
         "commitmentConfiguration": { 
            "automaticRenewal": boolean,
            "commitmentLength": "string"
         },
         "expiresOn": "string",
         "startAt": "string"
      },
      "createdAt": "string",
      "description": "string",
      "health": "string",
      "model": "string",
      "networkArn": "string",
      "networkResourceArn": "string",
      "networkSiteArn": "string",
      "orderArn": "string",
      "position": { 
         "elevation": number,
         "elevationReference": "string",
         "elevationUnit": "string",
         "latitude": number,
         "longitude": number
      },
      "returnInformation": { 
         "replacementOrderArn": "string",
         "returnReason": "string",
         "shippingAddress": { 
            "city": "string",
            "company": "string",
            "country": "string",
            "emailAddress": "string",
            "name": "string",
            "phoneNumber": "string",
            "postalCode": "string",
            "stateOrProvince": "string",
            "street1": "string",
            "street2": "string",
            "street3": "string"
         },
         "shippingLabel": "string"
      },
      "serialNumber": "string",
      "status": "string",
      "statusReason": "string",
      "type": "string",
      "vendor": "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.

networkResource

Information about the network resource.

Type: NetworkResource object

tags

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