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

GetSolNetworkPackage

Gets the details of a network package.

A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the AWS infrastructure you want to deploy them on.

Request Syntax


GET /sol/nsd/v1/ns_descriptors/nsdInfoId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

nsdInfoId

ID of the network service descriptor in the network package.

Pattern: ^np-[a-f0-9]{17}$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "id": "string",
   "metadata": { 
      "createdAt": "string",
      "lastModified": "string",
      "nsd": { 
         "overrides": [ 
            { 
               "defaultValue": "string",
               "name": "string"
            }
         ]
      }
   },
   "nsdId": "string",
   "nsdName": "string",
   "nsdOnboardingState": "string",
   "nsdOperationalState": "string",
   "nsdUsageState": "string",
   "nsdVersion": "string",
   "tags": { 
      "string" : "string" 
   },
   "vnfPkgIds": [ "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.

arn

Network package ARN.

Type: String

Pattern: ^arn:(aws|aws-cn|aws-iso|aws-iso-b|aws-us-gov):tnb:([a-z]{2}(-(gov|isob|iso))?-(east|west|north|south|central){1,2}-[0-9]):\d{12}:(network-package/np-[a-f0-9]{17})$

id

Network package ID.

Type: String

Pattern: ^np-[a-f0-9]{17}$

metadata

Metadata associated with a network package.

A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the AWS infrastructure you want to deploy them on.

Type: GetSolNetworkPackageMetadata object

nsdId

Network service descriptor ID.

Type: String

Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

nsdName

Network service descriptor name.

Type: String

nsdOnboardingState

Network service descriptor onboarding state.

Type: String

Valid Values: CREATED | ONBOARDED | ERROR

nsdOperationalState

Network service descriptor operational state.

Type: String

Valid Values: ENABLED | DISABLED

nsdUsageState

Network service descriptor usage state.

Type: String

Valid Values: IN_USE | NOT_IN_USE

nsdVersion

Network service descriptor version.

Type: String

tags

A tag is a label that you assign to an AWS resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your AWS costs.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 200 items.

Key Pattern: ^(?!aws:).{1,128}$

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

vnfPkgIds

Identifies the function package for the function package descriptor referenced by the onboarded network package.

Type: Array of strings

Pattern: ^fp-[a-f0-9]{17}$

Errors

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

AccessDeniedException

Insufficient permissions to make request.

HTTP Status Code: 403

InternalServerException

Unexpected error occurred. Problem on the server.

HTTP Status Code: 500

ResourceNotFoundException

Request references a resource that doesn't exist.

HTTP Status Code: 404

ThrottlingException

Exception caused by throttling.

HTTP Status Code: 429

ValidationException

Unable to process the request because the client provided input failed to satisfy request constraints.

HTTP Status Code: 400