Skip to content

list_listeners 

list_listeners(
    service_identifier: ServiceIdentifier,
    *,
    config_overrides: Optional[VPCLatticeClientConfig] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> ListListenersResponse

Lists the listeners for the specified service.

Parameters:

  • service_identifier (ServiceIdentifier) –

    The ID or ARN of the service.

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

    The maximum number of results to return.

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

    A pagination token for the next page of results.

Raises:

Source code in docs_src/capo_vpc_lattice/_services/vpc_lattice.py 
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
def list_listeners(
    self,
    service_identifier: "capo_vpc_lattice.types.service_identifier.ServiceIdentifier",
    *,
    config_overrides: Optional[VPCLatticeClientConfig] = None,
    max_results: Optional["capo_vpc_lattice.types.max_results.MaxResults"] = None,
    next_token: Optional["capo_vpc_lattice.types.next_token.NextToken"] = None,
) -> "capo_vpc_lattice.types.list_listeners_response.ListListenersResponse":
    """<p>Lists the listeners for the specified service.</p>

    Args:
        service_identifier: <p>The ID or ARN of the service.</p>
        max_results: <p>The maximum number of results to return.</p>
        next_token: <p>A pagination token for the next page of results.</p>

    Raises:
        capo_vpc_lattice.errors.access_denied_exception.AccessDeniedException: <p>The user does not have sufficient access to perform this action.</p>
        capo_vpc_lattice.errors.internal_server_exception.InternalServerException: <p>An unexpected error occurred while processing the request.</p>
        capo_vpc_lattice.errors.resource_not_found_exception.ResourceNotFoundException: <p>The request references a resource that does not exist.</p>
        capo_vpc_lattice.errors.throttling_exception.ThrottlingException: <p>The limit on the number of requests per second was exceeded.</p>
        capo_vpc_lattice.errors.validation_exception.ValidationException: <p>The input does not satisfy the constraints specified by an Amazon Web Services service.</p>
        capo_vpc_lattice.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_vpc_lattice.types.list_listeners_request.ListListenersRequest]",
    ) -> OperationResponse[
        "capo_vpc_lattice.types.list_listeners_response.ListListenersResponse"
    ]:
        import capo_vpc_lattice._operations.mercury_control_plane.list_listeners

        output, http_response = (
            capo_vpc_lattice._operations.mercury_control_plane.list_listeners.list_listeners(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListListeners")
    )
    input_: capo_vpc_lattice.types.list_listeners_request.ListListenersRequest = {
        "service_identifier": service_identifier
    }
    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