Skip to content

list_sol_network_instances

list_sol_network_instances(
    *,
    config_overrides: Optional[tnbClientConfig] = None,
    max_results: Optional[int] = None,
    next_token: Optional[PaginationToken] = None,
) -> ListSolNetworkInstancesOutput

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.

Parameters:

  • max_results (Optional[int], default: None ) –

    The maximum number of results to include in the response.

  • next_token (Optional[PaginationToken], default: None ) –

    The token for the next page of results.

Raises:

Examples:

List Sol Network Instantiate instances

>>> client.list_sol_network_instances()
List Sol Network Instances with nextToken and maxResults
>>> client.list_sol_network_instances(max_results=25, next_token='')
Source code in docs_src/capo_tnb/_services/tnb.py
def list_sol_network_instances(
    self,
    *,
    config_overrides: Optional[tnbClientConfig] = None,
    max_results: Optional[int] = None,
    next_token: Optional["capo_tnb.types.pagination_token.PaginationToken"] = None,
) -> (
    "capo_tnb.types.list_sol_network_instances_output.ListSolNetworkInstancesOutput"
):
    """<p>Lists your network instances.</p> <p>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.</p>

    Args:
        max_results: <p>The maximum number of results to include in the response.</p>
        next_token: <p>The token for the next page of results.</p>

    Raises:
        capo_tnb.errors.access_denied_exception.AccessDeniedException: <p>Insufficient permissions to make request.</p>
        capo_tnb.errors.internal_server_exception.InternalServerException: <p>Unexpected error occurred. Problem on the server.</p>
        capo_tnb.errors.throttling_exception.ThrottlingException: <p>Exception caused by throttling.</p>
        capo_tnb.errors.validation_exception.ValidationException: <p>Unable to process the request because the client provided input failed to satisfy request constraints.</p>
        capo_tnb.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        List Sol Network Instantiate instances

        >>> client.list_sol_network_instances()
        List Sol Network Instances with nextToken and maxResults

        >>> client.list_sol_network_instances(max_results=25, next_token='')
    """

    def _handler(
        req: "OperationRequest[capo_tnb.types.list_sol_network_instances_input.ListSolNetworkInstancesInput]",
    ) -> OperationResponse[
        "capo_tnb.types.list_sol_network_instances_output.ListSolNetworkInstancesOutput"
    ]:
        import capo_tnb._operations.tnb.list_sol_network_instances

        output, http_response = (
            capo_tnb._operations.tnb.list_sol_network_instances.list_sol_network_instances(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListSolNetworkInstances")
    )
    input_: capo_tnb.types.list_sol_network_instances_input.ListSolNetworkInstancesInput = {}
    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