Skip to content

get_network_resource_counts

get_network_resource_counts(
    global_network_id: GlobalNetworkId,
    *,
    config_overrides: Optional[NetworkManagerClientConfig] = None,
    resource_type: Optional[ConstrainedString] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> GetNetworkResourceCountsResponse

Gets the count of network resources, by resource type, for the specified global network.

Parameters:

  • global_network_id (GlobalNetworkId) –

    The ID of the global network.

  • resource_type (Optional[ConstrainedString], default: None ) –

    The resource type.

    The following are the supported resource types for Direct Connect:

    • dxcon

    • dx-gateway

    • dx-vif

    The following are the supported resource types for Network Manager:

    • attachment

    • connect-peer

    • connection

    • core-network

    • device

    • link

    • peering

    • site

    The following are the supported resource types for Amazon VPC:

    • customer-gateway

    • transit-gateway

    • transit-gateway-attachment

    • transit-gateway-connect-peer

    • transit-gateway-route-table

    • vpn-connection

  • 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 get_network_resource_counts(
    self,
    global_network_id: "capo_networkmanager.types.global_network_id.GlobalNetworkId",
    *,
    config_overrides: Optional[NetworkManagerClientConfig] = None,
    resource_type: Optional[
        "capo_networkmanager.types.constrained_string.ConstrainedString"
    ] = None,
    max_results: Optional[
        "capo_networkmanager.types.max_results.MaxResults"
    ] = None,
    next_token: Optional["capo_networkmanager.types.next_token.NextToken"] = None,
) -> "capo_networkmanager.types.get_network_resource_counts_response.GetNetworkResourceCountsResponse":
    """<p>Gets the count of network resources, by resource type, for the specified global network.</p>

    Args:
        global_network_id: <p>The ID of the global network.</p>
        resource_type: <p>The resource type.</p> <p>The following are the supported resource types for Direct Connect:</p> <ul> <li> <p> <code>dxcon</code> </p> </li> <li> <p> <code>dx-gateway</code> </p> </li> <li> <p> <code>dx-vif</code> </p> </li> </ul> <p>The following are the supported resource types for Network Manager:</p> <ul> <li> <p> <code>attachment</code> </p> </li> <li> <p> <code>connect-peer</code> </p> </li> <li> <p> <code>connection</code> </p> </li> <li> <p> <code>core-network</code> </p> </li> <li> <p> <code>device</code> </p> </li> <li> <p> <code>link</code> </p> </li> <li> <p> <code>peering</code> </p> </li> <li> <p> <code>site</code> </p> </li> </ul> <p>The following are the supported resource types for Amazon VPC:</p> <ul> <li> <p> <code>customer-gateway</code> </p> </li> <li> <p> <code>transit-gateway</code> </p> </li> <li> <p> <code>transit-gateway-attachment</code> </p> </li> <li> <p> <code>transit-gateway-connect-peer</code> </p> </li> <li> <p> <code>transit-gateway-route-table</code> </p> </li> <li> <p> <code>vpn-connection</code> </p> </li> </ul>
        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.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.get_network_resource_counts_request.GetNetworkResourceCountsRequest]",
    ) -> OperationResponse[
        "capo_networkmanager.types.get_network_resource_counts_response.GetNetworkResourceCountsResponse"
    ]:
        import capo_networkmanager._operations.network_manager.get_network_resource_counts

        output, http_response = (
            capo_networkmanager._operations.network_manager.get_network_resource_counts.get_network_resource_counts(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetNetworkResourceCounts")
    )
    input_: capo_networkmanager.types.get_network_resource_counts_request.GetNetworkResourceCountsRequest = {
        "global_network_id": global_network_id
    }
    if resource_type is not None:
        input_["resource_type"] = resource_type
    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