Private5G.Paginator.ListNetworkSites¶paginator = client.get_paginator('list_network_sites')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Private5G.Client.list_network_sites().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
filters={
'string': [
'string',
]
},
networkArn='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The filters. Add filters to your request to return a more specific list of results. Use filters to match the status of the network sites.
STATUS - The status ( AVAILABLE | CREATED | DELETED | DEPROVISIONING | PROVISIONING ).Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR , and the request returns all results that match any of the specified values.
[REQUIRED]
The Amazon Resource Name (ARN) of the network.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'networkSites': [
{
'availabilityZone': 'string',
'availabilityZoneId': 'string',
'createdAt': datetime(2015, 1, 1),
'currentPlan': {
'options': [
{
'name': 'string',
'value': 'string'
},
],
'resourceDefinitions': [
{
'count': 123,
'options': [
{
'name': 'string',
'value': 'string'
},
],
'type': 'RADIO_UNIT'|'DEVICE_IDENTIFIER'
},
]
},
'description': 'string',
'networkArn': 'string',
'networkSiteArn': 'string',
'networkSiteName': 'string',
'pendingPlan': {
'options': [
{
'name': 'string',
'value': 'string'
},
],
'resourceDefinitions': [
{
'count': 123,
'options': [
{
'name': 'string',
'value': 'string'
},
],
'type': 'RADIO_UNIT'|'DEVICE_IDENTIFIER'
},
]
},
'status': 'CREATED'|'PROVISIONING'|'AVAILABLE'|'DEPROVISIONING'|'DELETED',
'statusReason': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
networkSites (list) --
Information about the network sites.
(dict) --
Information about a network site.
availabilityZone (string) --
The parent Availability Zone for the network site.
availabilityZoneId (string) --
The parent Availability Zone ID for the network site.
createdAt (datetime) --
The creation time of the network site.
currentPlan (dict) --
The current plan of the network site.
options (list) --
The options of the plan.
(dict) --
Information about a name/value pair.
name (string) --
The name of the pair.
value (string) --
The value of the pair.
resourceDefinitions (list) --
The resource definitions of the plan.
(dict) --
Information about a network resource definition.
count (integer) --
The count in the network resource definition.
options (list) --
The options in the network resource definition.
(dict) --
Information about a name/value pair.
name (string) --
The name of the pair.
value (string) --
The value of the pair.
type (string) --
The type in the network resource definition.
description (string) --
The description of the network site.
networkArn (string) --
The Amazon Resource Name (ARN) of the network to which the network site belongs.
networkSiteArn (string) --
The Amazon Resource Name (ARN) of the network site.
networkSiteName (string) --
The name of the network site.
pendingPlan (dict) --
The pending plan of the network site.
options (list) --
The options of the plan.
(dict) --
Information about a name/value pair.
name (string) --
The name of the pair.
value (string) --
The value of the pair.
resourceDefinitions (list) --
The resource definitions of the plan.
(dict) --
Information about a network resource definition.
count (integer) --
The count in the network resource definition.
options (list) --
The options in the network resource definition.
(dict) --
Information about a name/value pair.
name (string) --
The name of the pair.
value (string) --
The value of the pair.
type (string) --
The type in the network resource definition.
status (string) --
The status of the network site.
statusReason (string) --
The status reason of the network site.
NextToken (string) --
A token to resume pagination.