2024/07/30 - AWS Telco Network Builder - 5 updated api methods
Changes This release adds Network Service Update, through which customers will be able to update their instantiated networks to a new network package. See the documentation for limitations. The release also enhances the Get network operation API to return parameter overrides used during the operation.
{'nsState': {'INTENT_TO_UPDATE_IN_PROGRESS', 'UPDATED', 'UPDATE_FAILED'}}
Gets the details of the network instance.
A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.
See also: AWS API Documentation
Request Syntax
client.get_sol_network_instance(
nsInstanceId='string'
)
string
[REQUIRED]
ID of the network instance.
dict
Response Syntax
{
'arn': 'string',
'id': 'string',
'lcmOpInfo': {
'nsLcmOpOccId': 'string'
},
'metadata': {
'createdAt': datetime(2015, 1, 1),
'lastModified': datetime(2015, 1, 1)
},
'nsInstanceDescription': 'string',
'nsInstanceName': 'string',
'nsState': 'INSTANTIATED'|'NOT_INSTANTIATED'|'UPDATED'|'IMPAIRED'|'UPDATE_FAILED'|'STOPPED'|'DELETED'|'INSTANTIATE_IN_PROGRESS'|'INTENT_TO_UPDATE_IN_PROGRESS'|'UPDATE_IN_PROGRESS'|'TERMINATE_IN_PROGRESS',
'nsdId': 'string',
'nsdInfoId': 'string',
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
arn (string) --
Network instance ARN.
id (string) --
Network instance ID.
lcmOpInfo (dict) --
Lifecycle management operation details on the network instance.
Lifecycle management operations are deploy, update, or delete operations.
nsLcmOpOccId (string) --
The identifier of the network operation.
metadata (dict) --
The metadata of a network instance.
A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.
createdAt (datetime) --
The date that the resource was created.
lastModified (datetime) --
The date that the resource was last modified.
nsInstanceDescription (string) --
Network instance description.
nsInstanceName (string) --
Network instance name.
nsState (string) --
Network instance state.
nsdId (string) --
Network service descriptor ID.
nsdInfoId (string) --
Network service descriptor info ID.
tags (dict) --
A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.
(string) --
(string) --
{'metadata': {'instantiateMetadata': {'additionalParamsForNs': {},
'nsdInfoId': 'string'},
'modifyVnfInfoMetadata': {'vnfConfigurableProperties': {},
'vnfInstanceId': 'string'},
'updateNsMetadata': {'additionalParamsForNs': {},
'nsdInfoId': 'string'}},
'updateType': 'MODIFY_VNF_INFORMATION | UPDATE_NS'}
Gets the details of a network operation, including the tasks involved in the network operation and the status of the tasks.
A network operation is any operation that is done to your network, such as network instance instantiation or termination.
See also: AWS API Documentation
Request Syntax
client.get_sol_network_operation(
nsLcmOpOccId='string'
)
string
[REQUIRED]
The identifier of the network operation.
dict
Response Syntax
{
'arn': 'string',
'error': {
'detail': 'string',
'title': 'string'
},
'id': 'string',
'lcmOperationType': 'INSTANTIATE'|'UPDATE'|'TERMINATE',
'metadata': {
'createdAt': datetime(2015, 1, 1),
'instantiateMetadata': {
'additionalParamsForNs': {...}|[...]|123|123.4|'string'|True|None,
'nsdInfoId': 'string'
},
'lastModified': datetime(2015, 1, 1),
'modifyVnfInfoMetadata': {
'vnfConfigurableProperties': {...}|[...]|123|123.4|'string'|True|None,
'vnfInstanceId': 'string'
},
'updateNsMetadata': {
'additionalParamsForNs': {...}|[...]|123|123.4|'string'|True|None,
'nsdInfoId': 'string'
}
},
'nsInstanceId': 'string',
'operationState': 'PROCESSING'|'COMPLETED'|'FAILED'|'CANCELLING'|'CANCELLED',
'tags': {
'string': 'string'
},
'tasks': [
{
'taskContext': {
'string': 'string'
},
'taskEndTime': datetime(2015, 1, 1),
'taskErrorDetails': {
'cause': 'string',
'details': 'string'
},
'taskName': 'string',
'taskStartTime': datetime(2015, 1, 1),
'taskStatus': 'SCHEDULED'|'STARTED'|'IN_PROGRESS'|'COMPLETED'|'ERROR'|'SKIPPED'|'CANCELLED'
},
],
'updateType': 'MODIFY_VNF_INFORMATION'|'UPDATE_NS'
}
Response Structure
(dict) --
arn (string) --
Network operation ARN.
error (dict) --
Error related to this specific network operation occurrence.
detail (string) --
A human-readable explanation specific to this occurrence of the problem.
title (string) --
A human-readable title of the problem type.
id (string) --
ID of this network operation occurrence.
lcmOperationType (string) --
Type of the operation represented by this occurrence.
metadata (dict) --
Metadata of this network operation occurrence.
createdAt (datetime) --
The date that the resource was created.
instantiateMetadata (dict) --
Metadata related to the network operation occurrence for network instantiation. This is populated only if the lcmOperationType is INSTANTIATE .
additionalParamsForNs (:ref:`document<document>`) --
The configurable properties used during instantiation.
nsdInfoId (string) --
The network service descriptor used for instantiating the network instance.
lastModified (datetime) --
The date that the resource was last modified.
modifyVnfInfoMetadata (dict) --
Metadata related to the network operation occurrence for network function updates in a network instance. This is populated only if the lcmOperationType is UPDATE and the updateType is MODIFY_VNF_INFORMATION .
vnfConfigurableProperties (:ref:`document<document>`) --
The configurable properties used during update of the network function instance.
vnfInstanceId (string) --
The network function instance that was updated in the network instance.
updateNsMetadata (dict) --
Metadata related to the network operation occurrence for network instance updates. This is populated only if the lcmOperationType is UPDATE and the updateType is UPDATE_NS .
additionalParamsForNs (:ref:`document<document>`) --
The configurable properties used during update.
nsdInfoId (string) --
The network service descriptor used for updating the network instance.
nsInstanceId (string) --
ID of the network operation instance.
operationState (string) --
The state of the network operation.
tags (dict) --
A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.
(string) --
(string) --
tasks (list) --
All tasks associated with this operation occurrence.
(dict) --
Gets the details of a network operation.
A network operation is any operation that is done to your network, such as network instance instantiation or termination.
taskContext (dict) --
Context for the network operation task.
(string) --
(string) --
taskEndTime (datetime) --
Task end time.
taskErrorDetails (dict) --
Task error details.
cause (string) --
Error cause.
details (string) --
Error details.
taskName (string) --
Task name.
taskStartTime (datetime) --
Task start time.
taskStatus (string) --
Task status.
updateType (string) --
Type of the update. Only present if the network operation lcmOperationType is UPDATE .
{'networkInstances': {'nsState': {'INTENT_TO_UPDATE_IN_PROGRESS',
'UPDATED',
'UPDATE_FAILED'}}}
Lists your network instances.
A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.
See also: AWS API Documentation
Request Syntax
client.list_sol_network_instances(
maxResults=123,
nextToken='string'
)
integer
The maximum number of results to include in the response.
string
The token for the next page of results.
dict
Response Syntax
{
'networkInstances': [
{
'arn': 'string',
'id': 'string',
'metadata': {
'createdAt': datetime(2015, 1, 1),
'lastModified': datetime(2015, 1, 1)
},
'nsInstanceDescription': 'string',
'nsInstanceName': 'string',
'nsState': 'INSTANTIATED'|'NOT_INSTANTIATED'|'UPDATED'|'IMPAIRED'|'UPDATE_FAILED'|'STOPPED'|'DELETED'|'INSTANTIATE_IN_PROGRESS'|'INTENT_TO_UPDATE_IN_PROGRESS'|'UPDATE_IN_PROGRESS'|'TERMINATE_IN_PROGRESS',
'nsdId': 'string',
'nsdInfoId': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
networkInstances (list) --
Lists network instances.
(dict) --
Info about the specific network instance.
A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.
arn (string) --
Network instance ARN.
id (string) --
ID of the network instance.
metadata (dict) --
The metadata of the network instance.
createdAt (datetime) --
The date that the resource was created.
lastModified (datetime) --
The date that the resource was last modified.
nsInstanceDescription (string) --
Human-readable description of the network instance.
nsInstanceName (string) --
Human-readable name of the network instance.
nsState (string) --
The state of the network instance.
nsdId (string) --
ID of the network service descriptor in the network package.
nsdInfoId (string) --
ID of the network service descriptor in the network package.
nextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
{'nsInstanceId': 'string'}
Response {'networkOperations': {'metadata': {'nsdInfoId': 'string',
'vnfInstanceId': 'string'},
'updateType': 'MODIFY_VNF_INFORMATION | UPDATE_NS'}}
Lists details for a network operation, including when the operation started and the status of the operation.
A network operation is any operation that is done to your network, such as network instance instantiation or termination.
See also: AWS API Documentation
Request Syntax
client.list_sol_network_operations(
maxResults=123,
nextToken='string',
nsInstanceId='string'
)
integer
The maximum number of results to include in the response.
string
The token for the next page of results.
string
Network instance id filter, to retrieve network operations associated to a network instance.
dict
Response Syntax
{
'networkOperations': [
{
'arn': 'string',
'error': {
'detail': 'string',
'title': 'string'
},
'id': 'string',
'lcmOperationType': 'INSTANTIATE'|'UPDATE'|'TERMINATE',
'metadata': {
'createdAt': datetime(2015, 1, 1),
'lastModified': datetime(2015, 1, 1),
'nsdInfoId': 'string',
'vnfInstanceId': 'string'
},
'nsInstanceId': 'string',
'operationState': 'PROCESSING'|'COMPLETED'|'FAILED'|'CANCELLING'|'CANCELLED',
'updateType': 'MODIFY_VNF_INFORMATION'|'UPDATE_NS'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
networkOperations (list) --
Lists network operation occurrences. Lifecycle management operations are deploy, update, or delete operations.
(dict) --
Information parameters for a network operation.
arn (string) --
Network operation ARN.
error (dict) --
Error related to this specific network operation.
detail (string) --
A human-readable explanation specific to this occurrence of the problem.
title (string) --
A human-readable title of the problem type.
id (string) --
ID of this network operation.
lcmOperationType (string) --
Type of lifecycle management network operation.
metadata (dict) --
Metadata related to this network operation.
createdAt (datetime) --
The date that the resource was created.
lastModified (datetime) --
The date that the resource was last modified.
nsdInfoId (string) --
The network service descriptor id used for the operation.
Only present if the updateType is UPDATE_NS .
vnfInstanceId (string) --
The network function id used for the operation.
Only present if the updateType is MODIFY_VNF_INFO .
nsInstanceId (string) --
ID of the network instance related to this operation.
operationState (string) --
The state of the network operation.
updateType (string) --
Type of the update. Only present if the network operation lcmOperationType is UPDATE .
nextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
{'updateNs': {'additionalParamsForNs': {}, 'nsdInfoId': 'string'},
'updateType': {'UPDATE_NS'}}
Update a network instance.
A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.
Choose the updateType parameter to target the necessary update of the network instance.
See also: AWS API Documentation
Request Syntax
client.update_sol_network_instance(
modifyVnfInfoData={
'vnfConfigurableProperties': {...}|[...]|123|123.4|'string'|True|None,
'vnfInstanceId': 'string'
},
nsInstanceId='string',
tags={
'string': 'string'
},
updateNs={
'additionalParamsForNs': {...}|[...]|123|123.4|'string'|True|None,
'nsdInfoId': 'string'
},
updateType='MODIFY_VNF_INFORMATION'|'UPDATE_NS'
)
dict
Identifies the network function information parameters and/or the configurable properties of the network function to be modified.
Include this property only if the update type is MODIFY_VNF_INFORMATION .
vnfConfigurableProperties (:ref:`document<document>`) -- [REQUIRED]
Provides values for the configurable properties declared in the function package descriptor.
vnfInstanceId (string) -- [REQUIRED]
ID of the network function instance.
A network function instance is a function in a function package .
string
[REQUIRED]
ID of the network instance.
dict
A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are only applied to the network operation that is created. These tags are not applied to the network instance. Use tags to search and filter your resources or track your Amazon Web Services costs.
(string) --
(string) --
dict
Identifies the network service descriptor and the configurable properties of the descriptor, to be used for the update.
Include this property only if the update type is UPDATE_NS .
additionalParamsForNs (:ref:`document<document>`) --
Values for the configurable properties declared in the network service descriptor.
nsdInfoId (string) -- [REQUIRED]
ID of the network service descriptor.
string
[REQUIRED]
The type of update.
Use the MODIFY_VNF_INFORMATION update type, to update a specific network function configuration, in the network instance.
Use the UPDATE_NS update type, to update the network instance to a new network service descriptor.
dict
Response Syntax
{
'nsLcmOpOccId': 'string',
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
nsLcmOpOccId (string) --
The identifier of the network operation.
tags (dict) --
A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are only applied to the network operation that is created. These tags are not applied to the network instance. Use tags to search and filter your resources or track your Amazon Web Services costs.
(string) --
(string) --