list_virtual_gateways ¶

def list_virtual_gateways(
    self,
    mesh_name: "capo_app_mesh.types.resource_name.ResourceName",
    *,
    config_overrides: Optional[AppMeshClientConfig] = None,
    next_token: Optional[str] = None,
    limit: Optional[
        "capo_app_mesh.types.list_virtual_gateways_limit.ListVirtualGatewaysLimit"
    ] = None,
    mesh_owner: Optional["capo_app_mesh.types.account_id.AccountId"] = None,
) -> "capo_app_mesh.types.list_virtual_gateways_output.ListVirtualGatewaysOutput":
    """<p>Returns a list of existing virtual gateways in a service mesh.</p>

    Args:
        mesh_name: <p>The name of the service mesh to list virtual gateways in.</p>
        next_token: <p>The <code>nextToken</code> value returned from a previous paginated <code>ListVirtualGateways</code> request where <code>limit</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value.</p>
        limit: <p>The maximum number of results returned by <code>ListVirtualGateways</code> in paginated output. When you use this parameter, <code>ListVirtualGateways</code> returns only <code>limit</code> results in a single page along with a <code>nextToken</code> response element. You can see the remaining results of the initial request by sending another <code>ListVirtualGateways</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If you don't use this parameter, <code>ListVirtualGateways</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p>
        mesh_owner: <p>The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html">Working with shared meshes</a>.</p>

    Raises:
        capo_app_mesh.errors.bad_request_exception.BadRequestException: <p>The request syntax was malformed. Check your request syntax and try again.</p>
        capo_app_mesh.errors.forbidden_exception.ForbiddenException: <p>You don't have permissions to perform this action.</p>
        capo_app_mesh.errors.internal_server_error_exception.InternalServerErrorException: <p>The request processing has failed because of an unknown error, exception, or failure.</p>
        capo_app_mesh.errors.not_found_exception.NotFoundException: <p>The specified resource doesn't exist. Check your request syntax and try again.</p>
        capo_app_mesh.errors.service_unavailable_exception.ServiceUnavailableException: <p>The request has failed due to a temporary failure of the service.</p>
        capo_app_mesh.errors.too_many_requests_exception.TooManyRequestsException: <p>The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best results, use an increasing or variable sleep interval between requests.</p>
        capo_app_mesh.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_app_mesh.types.list_virtual_gateways_input.ListVirtualGatewaysInput]",
    ) -> OperationResponse[
        "capo_app_mesh.types.list_virtual_gateways_output.ListVirtualGatewaysOutput"
    ]:
        import capo_app_mesh._operations.app_mesh.list_virtual_gateways

        output, http_response = (
            capo_app_mesh._operations.app_mesh.list_virtual_gateways.list_virtual_gateways(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListVirtualGateways")
    )
    input_: capo_app_mesh.types.list_virtual_gateways_input.ListVirtualGatewaysInput = {
        "mesh_name": mesh_name
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if limit is not None:
        input_["limit"] = limit
    if mesh_owner is not None:
        input_["mesh_owner"] = mesh_owner

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output