Skip to content

iter_list_environments

iter_list_environments(
    domain_identifier: DomainId,
    project_identifier: ProjectId,
    *,
    config_overrides: Optional[DataZoneClientConfig] = None,
    aws_account_id: Optional[AwsAccountId] = None,
    status: Optional[EnvironmentStatus] = None,
    aws_account_region: Optional[AwsRegion] = None,
    environment_profile_identifier: Optional[EnvironmentProfileId] = None,
    environment_blueprint_identifier: Optional[EnvironmentBlueprintId] = None,
    provider: Optional[str] = None,
    name: Optional[str] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[PaginationToken] = None,
) -> Iterator[EnvironmentSummary]
Source code in docs_src/capo_datazone/_services/data_zone.py
def iter_list_environments(
    self,
    domain_identifier: "capo_datazone.types.domain_id.DomainId",
    project_identifier: "capo_datazone.types.project_id.ProjectId",
    *,
    config_overrides: Optional[DataZoneClientConfig] = None,
    aws_account_id: Optional[
        "capo_datazone.types.aws_account_id.AwsAccountId"
    ] = None,
    status: Optional[
        "capo_datazone.types.environment_status.EnvironmentStatus"
    ] = None,
    aws_account_region: Optional["capo_datazone.types.aws_region.AwsRegion"] = None,
    environment_profile_identifier: Optional[
        "capo_datazone.types.environment_profile_id.EnvironmentProfileId"
    ] = None,
    environment_blueprint_identifier: Optional[
        "capo_datazone.types.environment_blueprint_id.EnvironmentBlueprintId"
    ] = None,
    provider: Optional[str] = None,
    name: Optional[str] = None,
    max_results: Optional["capo_datazone.types.max_results.MaxResults"] = None,
    next_token: Optional[
        "capo_datazone.types.pagination_token.PaginationToken"
    ] = None,
) -> "Iterator[capo_datazone.types.environment_summary.EnvironmentSummary]":
    _token = next_token
    while True:
        _response = self.list_environments(
            domain_identifier,
            project_identifier,
            config_overrides=config_overrides,
            aws_account_id=aws_account_id,
            status=status,
            aws_account_region=aws_account_region,
            environment_profile_identifier=environment_profile_identifier,
            environment_blueprint_identifier=environment_blueprint_identifier,
            provider=provider,
            name=name,
            max_results=max_results,
            next_token=_token,
        )
        _page = _resolve_path(_response, ("items",))
        for _item in _page or []:
            yield _item
        _token = _resolve_path(_response, ("next_token",))
        if not _token:
            break