Skip to content

iter_describe_cases async

iter_describe_cases(
    *,
    config_overrides: Optional[AsyncSupportClientConfig] = None,
    case_id_list: Optional[CaseIdList] = None,
    display_id: Optional[DisplayId] = None,
    after_time: Optional[AfterTime] = None,
    before_time: Optional[BeforeTime] = None,
    include_resolved_cases: Optional[IncludeResolvedCases] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
    language: Optional[Language] = None,
    include_communications: Optional[IncludeCommunications] = None,
    dry_run: Optional[NullableBooleanType] = None,
) -> AsyncIterator[CaseDetails]
Source code in docs_src/capo_support/_services/async_support.py
async def iter_describe_cases(
    self,
    *,
    config_overrides: Optional[AsyncSupportClientConfig] = None,
    case_id_list: Optional["capo_support.types.case_id_list.CaseIdList"] = None,
    display_id: Optional["capo_support.types.display_id.DisplayId"] = None,
    after_time: Optional["capo_support.types.after_time.AfterTime"] = None,
    before_time: Optional["capo_support.types.before_time.BeforeTime"] = None,
    include_resolved_cases: Optional[
        "capo_support.types.include_resolved_cases.IncludeResolvedCases"
    ] = None,
    next_token: Optional["capo_support.types.next_token.NextToken"] = None,
    max_results: Optional["capo_support.types.max_results.MaxResults"] = None,
    language: Optional["capo_support.types.language.Language"] = None,
    include_communications: Optional[
        "capo_support.types.include_communications.IncludeCommunications"
    ] = None,
    dry_run: Optional[
        "capo_support.types.nullable_boolean_type.NullableBooleanType"
    ] = None,
) -> "AsyncIterator[capo_support.types.case_details.CaseDetails]":
    _token = next_token
    while True:
        _response = await self.describe_cases(
            config_overrides=config_overrides,
            case_id_list=case_id_list,
            display_id=display_id,
            after_time=after_time,
            before_time=before_time,
            include_resolved_cases=include_resolved_cases,
            next_token=_token,
            max_results=max_results,
            language=language,
            include_communications=include_communications,
            dry_run=dry_run,
        )
        _page = _resolve_path(_response, ("cases",))
        for _item in _page or []:
            yield _item
        _token = _resolve_path(_response, ("next_token",))
        if not _token:
            break