Describes one or more global networks. By default, all global networks are described. To describe the objects in your global network, you must use the appropriate Get* action. For example, to list the transit gateways in your global network, use GetTransitGatewayRegistrations.
Parameters:
-
global_network_ids
(Optional[GlobalNetworkIdList], default:
None
)
–
The IDs of one or more global networks. The maximum is 10.
-
max_results
(Optional[MaxResults], default:
None
)
–
The maximum number of results to return.
-
next_token
(Optional[NextToken], default:
None
)
–
The token for the next page of results.
Raises:
Source code in docs_src/capo_networkmanager/_services/network_manager.py
| def describe_global_networks(
self,
*,
config_overrides: Optional[NetworkManagerClientConfig] = None,
global_network_ids: Optional[
"capo_networkmanager.types.global_network_id_list.GlobalNetworkIdList"
] = None,
max_results: Optional[
"capo_networkmanager.types.max_results.MaxResults"
] = None,
next_token: Optional["capo_networkmanager.types.next_token.NextToken"] = None,
) -> "capo_networkmanager.types.describe_global_networks_response.DescribeGlobalNetworksResponse":
"""<p>Describes one or more global networks. By default, all global networks are described. To describe the objects in your global network, you must use the appropriate <code>Get*</code> action. For example, to list the transit gateways in your global network, use <a>GetTransitGatewayRegistrations</a>.</p>
Args:
global_network_ids: <p>The IDs of one or more global networks. The maximum is 10.</p>
max_results: <p>The maximum number of results to return.</p>
next_token: <p>The token for the next page of results.</p>
Raises:
capo_networkmanager.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
capo_networkmanager.errors.internal_server_exception.InternalServerException: <p>The request has failed due to an internal error.</p>
capo_networkmanager.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource could not be found.</p>
capo_networkmanager.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
capo_networkmanager.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints.</p>
capo_networkmanager.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_networkmanager.types.describe_global_networks_request.DescribeGlobalNetworksRequest]",
) -> OperationResponse[
"capo_networkmanager.types.describe_global_networks_response.DescribeGlobalNetworksResponse"
]:
import capo_networkmanager._operations.network_manager.describe_global_networks
output, http_response = (
capo_networkmanager._operations.network_manager.describe_global_networks.describe_global_networks(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeGlobalNetworks")
)
input_: capo_networkmanager.types.describe_global_networks_request.DescribeGlobalNetworksRequest = {}
if global_network_ids is not None:
input_["global_network_ids"] = global_network_ids
if max_results is not None:
input_["max_results"] = max_results
if next_token is not None:
input_["next_token"] = next_token
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|