list_meshes `async` ¶

list_meshes(
    *,
    config_overrides: Optional[AsyncAppMeshClientConfig] = None,
    next_token: Optional[str] = None,
    limit: Optional[ListMeshesLimit] = None,
) -> ListMeshesOutput

Returns a list of existing service meshes.

Parameters:

next_token (Optional[str], default: None ) –

The nextToken value returned from a previous paginated ListMeshes request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.
limit (Optional[ListMeshesLimit], default: None ) –

The maximum number of results returned by ListMeshes in paginated output. When you use this parameter, ListMeshes returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListMeshes request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListMeshes returns up to 100 results and a nextToken value if applicable.

Raises:

BadRequestException –

The request syntax was malformed. Check your request syntax and try again.
ForbiddenException –

You don't have permissions to perform this action.
InternalServerErrorException –

The request processing has failed because of an unknown error, exception, or failure.
NotFoundException –

The specified resource doesn't exist. Check your request syntax and try again.
ServiceUnavailableException –

The request has failed due to a temporary failure of the service.
TooManyRequestsException –

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.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_app_mesh/_services/async_app_mesh.py

async def list_meshes(
    self,
    *,
    config_overrides: Optional[AsyncAppMeshClientConfig] = None,
    next_token: Optional[str] = None,
    limit: Optional["capo_app_mesh.types.list_meshes_limit.ListMeshesLimit"] = None,
) -> "capo_app_mesh.types.list_meshes_output.ListMeshesOutput":
    """<p>Returns a list of existing service meshes.</p>

    Args:
        next_token: <p>The <code>nextToken</code> value returned from a previous paginated <code>ListMeshes</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> <note> <p>This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.</p> </note>
        limit: <p>The maximum number of results returned by <code>ListMeshes</code> in paginated output. When you use this parameter, <code>ListMeshes</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>ListMeshes</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>ListMeshes</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_app_mesh.types.list_meshes_input.ListMeshesInput]",
    ) -> AsyncOperationResponse[
        "capo_app_mesh.types.list_meshes_output.ListMeshesOutput"
    ]:
        import capo_app_mesh._operations.app_mesh.list_meshes

        (
            output,
            http_response,
        ) = await capo_app_mesh._operations.app_mesh.list_meshes.async_list_meshes(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListMeshes")
    )
    input_: capo_app_mesh.types.list_meshes_input.ListMeshesInput = {}
    if next_token is not None:
        input_["next_token"] = next_token
    if limit is not None:
        input_["limit"] = limit

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

list_meshes async ¶

list_meshes `async` ¶