Gets the details of an individual function package, such as the operational state and whether the package is in use.
A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network..
Request Syntax
GET /sol/vnfpkgm/v1/vnf_packages/vnfPkgId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- vnfPkgId
-
ID of the function package.
Pattern:
^fp-[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",
"vnfd": {
"overrides": [
{
"defaultValue": "string",
"name": "string"
}
]
}
},
"onboardingState": "string",
"operationalState": "string",
"tags": {
"string" : "string"
},
"usageState": "string",
"vnfdId": "string",
"vnfdVersion": "string",
"vnfProductName": "string",
"vnfProvider": "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
-
Function 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}:(function-package/fp-[a-f0-9]{17})$ - id
-
Function package ID.
Type: String
Pattern:
^fp-[a-f0-9]{17}$ - metadata
-
Metadata related to the function package.
A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.
Type: GetSolFunctionPackageMetadata object
- onboardingState
-
Function package onboarding state.
Type: String
Valid Values:
CREATED | ONBOARDED | ERROR - operationalState
-
Function package operational state.
Type: String
Valid Values:
ENABLED | DISABLED -
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.
- usageState
-
Function package usage state.
Type: String
Valid Values:
IN_USE | NOT_IN_USE - vnfdId
-
Function package descriptor ID.
Type: String
- vnfdVersion
-
Function package descriptor version.
Type: String
- vnfProductName
-
Network function product name.
Type: String
- vnfProvider
-
Network function provider.
Type: String
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
