Skip to content

list_application_instances

list_application_instances(
    *,
    config_overrides: Optional[PanoramaClientConfig] = None,
    device_id: Optional[DeviceId] = None,
    status_filter: Optional[StatusFilter] = None,
    max_results: Optional[MaxSize25] = None,
    next_token: Optional[NextToken] = None,
) -> ListApplicationInstancesResponse

Returns a list of application instances.

Parameters:

  • device_id (Optional[DeviceId], default: None ) –

    The application instances' device ID.

  • status_filter (Optional[StatusFilter], default: None ) –

    Only include instances with a specific status.

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

    The maximum number of application instances to return in one page of results.

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

    Specify the pagination token from a previous request to retrieve the next page of results.

Raises:

Source code in docs_src/capo_panorama/_services/panorama.py
def list_application_instances(
    self,
    *,
    config_overrides: Optional[PanoramaClientConfig] = None,
    device_id: Optional["capo_panorama.types.device_id.DeviceId"] = None,
    status_filter: Optional[
        "capo_panorama.types.status_filter.StatusFilter"
    ] = None,
    max_results: Optional["capo_panorama.types.max_size25.MaxSize25"] = None,
    next_token: Optional["capo_panorama.types.next_token.NextToken"] = None,
) -> "capo_panorama.types.list_application_instances_response.ListApplicationInstancesResponse":
    """<p>Returns a list of application instances.</p>

    Args:
        device_id: <p>The application instances' device ID.</p>
        status_filter: <p>Only include instances with a specific status.</p>
        max_results: <p>The maximum number of application instances to return in one page of results.</p>
        next_token: <p>Specify the pagination token from a previous request to retrieve the next page of results.</p>

    Raises:
        capo_panorama.errors.access_denied_exception.AccessDeniedException: <p>The requestor does not have permission to access the target action or resource.</p>
        capo_panorama.errors.internal_server_exception.InternalServerException: <p>An internal error occurred.</p>
        capo_panorama.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_panorama.types.list_application_instances_request.ListApplicationInstancesRequest]",
    ) -> OperationResponse[
        "capo_panorama.types.list_application_instances_response.ListApplicationInstancesResponse"
    ]:
        import capo_panorama._operations.omni_cloud_service_lambda.list_application_instances

        output, http_response = (
            capo_panorama._operations.omni_cloud_service_lambda.list_application_instances.list_application_instances(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListApplicationInstances")
    )
    input_: capo_panorama.types.list_application_instances_request.ListApplicationInstancesRequest = {}
    if device_id is not None:
        input_["device_id"] = device_id
    if status_filter is not None:
        input_["status_filter"] = status_filter
    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