iter_describe_canaries `async` ¶

iter_describe_canaries(
    *,
    config_overrides: Optional[AsyncsyntheticsClientConfig] = None,
    next_token: Optional[Token] = None,
    max_results: Optional[MaxCanaryResults] = None,
    names: Optional[DescribeCanariesNameFilter] = None,
) -> AsyncIterator[DescribeCanariesResponse]

Source code in docs_src/capo_synthetics/_services/async_synthetics.py

async def iter_describe_canaries(
    self,
    *,
    config_overrides: Optional[AsyncsyntheticsClientConfig] = None,
    next_token: Optional["capo_synthetics.types.token.Token"] = None,
    max_results: Optional[
        "capo_synthetics.types.max_canary_results.MaxCanaryResults"
    ] = None,
    names: Optional[
        "capo_synthetics.types.describe_canaries_name_filter.DescribeCanariesNameFilter"
    ] = None,
) -> "AsyncIterator[capo_synthetics.types.describe_canaries_response.DescribeCanariesResponse]":
    _token = next_token
    while True:
        _response = await self.describe_canaries(
            config_overrides=config_overrides,
            next_token=_token,
            max_results=max_results,
            names=names,
        )
        yield _response
        _token = _resolve_path(_response, ("next_token",))
        if not _token:
            break

iter_describe_canaries async ¶

iter_describe_canaries `async` ¶