Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Prefect Provider
  3. API Docs
  4. getWorkQueues
prefect 2.26.1 published on Friday, May 9, 2025 by prefecthq
prefecthq/terraform-provider-prefect

prefect.getWorkQueues

Explore with Pulumi AI

prefect logo
prefect 2.26.1 published on Friday, May 9, 2025 by prefecthq
prefecthq/terraform-provider-prefect

    Get information about multiple Work Queues.
    Use this data source to search for multiple Work Queues. Defaults to fetching all Work Queues in the Workspace.
    For more information, see work queues.

    This feature is available in the following product plan(s): Prefect OSS, Prefect Cloud (Free), Prefect Cloud (Pro), Prefect Cloud (Enterprise).

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as prefect from "@pulumi/prefect";

const test = prefect.getWorkQueues({
    workPoolName: prefect_work_pool.test.name,
    workspaceId: prefect_workspace.test.id,
});

    import pulumi
import pulumi_prefect as prefect

test = prefect.get_work_queues(work_pool_name=prefect_work_pool["test"]["name"],
    workspace_id=prefect_workspace["test"]["id"])

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/prefect/v2/prefect"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := prefect.GetWorkQueues(ctx, &prefect.GetWorkQueuesArgs{
			WorkPoolName: prefect_work_pool.Test.Name,
			WorkspaceId:  pulumi.StringRef(prefect_workspace.Test.Id),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Prefect = Pulumi.Prefect;

return await Deployment.RunAsync(() => 
{
    var test = Prefect.GetWorkQueues.Invoke(new()
    {
        WorkPoolName = prefect_work_pool.Test.Name,
        WorkspaceId = prefect_workspace.Test.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.prefect.PrefectFunctions;
import com.pulumi.prefect.inputs.GetWorkQueuesArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var test = PrefectFunctions.getWorkQueues(GetWorkQueuesArgs.builder()
            .workPoolName(prefect_work_pool.test().name())
            .workspaceId(prefect_workspace.test().id())
            .build());

    }
}

    variables:
  test:
    fn::invoke:
      function: prefect:getWorkQueues
      arguments:
        workPoolName: ${prefect_work_pool.test.name}
        workspaceId: ${prefect_workspace.test.id}

    Using getWorkQueues

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getWorkQueues(args: GetWorkQueuesArgs, opts?: InvokeOptions): Promise<GetWorkQueuesResult>
function getWorkQueuesOutput(args: GetWorkQueuesOutputArgs, opts?: InvokeOptions): Output<GetWorkQueuesResult>
    def get_work_queues(account_id: Optional[str] = None,
                    filter_anies: Optional[Sequence[str]] = None,
                    work_pool_name: Optional[str] = None,
                    workspace_id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetWorkQueuesResult
def get_work_queues_output(account_id: Optional[pulumi.Input[str]] = None,
                    filter_anies: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                    work_pool_name: Optional[pulumi.Input[str]] = None,
                    workspace_id: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetWorkQueuesResult]
    func GetWorkQueues(ctx *Context, args *GetWorkQueuesArgs, opts ...InvokeOption) (*GetWorkQueuesResult, error)
func GetWorkQueuesOutput(ctx *Context, args *GetWorkQueuesOutputArgs, opts ...InvokeOption) GetWorkQueuesResultOutput

    > Note: This function is named GetWorkQueues in the Go SDK.

    public static class GetWorkQueues 
{
    public static Task<GetWorkQueuesResult> InvokeAsync(GetWorkQueuesArgs args, InvokeOptions? opts = null)
    public static Output<GetWorkQueuesResult> Invoke(GetWorkQueuesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetWorkQueuesResult> getWorkQueues(GetWorkQueuesArgs args, InvokeOptions options)
public static Output<GetWorkQueuesResult> getWorkQueues(GetWorkQueuesArgs args, InvokeOptions options)

    fn::invoke:
  function: prefect:index/getWorkQueues:getWorkQueues
  arguments:
    # arguments dictionary

    The following arguments are supported:

    WorkPoolName string
    Name of the associated work pool
    AccountId string
    Account ID (UUID), defaults to the account set in the provider
    FilterAnies List<string>
    Work queue IDs (UUID) to search for (work queues with any matching UUID are returned)
    WorkspaceId string
    Workspace ID (UUID), defaults to the workspace set in the provider
    WorkPoolName string
    Name of the associated work pool
    AccountId string
    Account ID (UUID), defaults to the account set in the provider
    FilterAnies []string
    Work queue IDs (UUID) to search for (work queues with any matching UUID are returned)
    WorkspaceId string
    Workspace ID (UUID), defaults to the workspace set in the provider
    workPoolName String
    Name of the associated work pool
    accountId String
    Account ID (UUID), defaults to the account set in the provider
    filterAnies List<String>
    Work queue IDs (UUID) to search for (work queues with any matching UUID are returned)
    workspaceId String
    Workspace ID (UUID), defaults to the workspace set in the provider
    workPoolName string
    Name of the associated work pool
    accountId string
    Account ID (UUID), defaults to the account set in the provider
    filterAnies string[]
    Work queue IDs (UUID) to search for (work queues with any matching UUID are returned)
    workspaceId string
    Workspace ID (UUID), defaults to the workspace set in the provider
    work_pool_name str
    Name of the associated work pool
    account_id str
    Account ID (UUID), defaults to the account set in the provider
    filter_anies Sequence[str]
    Work queue IDs (UUID) to search for (work queues with any matching UUID are returned)
    workspace_id str
    Workspace ID (UUID), defaults to the workspace set in the provider
    workPoolName String
    Name of the associated work pool
    accountId String
    Account ID (UUID), defaults to the account set in the provider
    filterAnies List<String>
    Work queue IDs (UUID) to search for (work queues with any matching UUID are returned)
    workspaceId String
    Workspace ID (UUID), defaults to the workspace set in the provider

    getWorkQueues Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    WorkPoolName string
    Name of the associated work pool
    WorkQueues List<GetWorkQueuesWorkQueue>
    Work queues returned by the server
    AccountId string
    Account ID (UUID), defaults to the account set in the provider
    FilterAnies List<string>
    Work queue IDs (UUID) to search for (work queues with any matching UUID are returned)
    WorkspaceId string
    Workspace ID (UUID), defaults to the workspace set in the provider
    Id string
    The provider-assigned unique ID for this managed resource.
    WorkPoolName string
    Name of the associated work pool
    WorkQueues []GetWorkQueuesWorkQueue
    Work queues returned by the server
    AccountId string
    Account ID (UUID), defaults to the account set in the provider
    FilterAnies []string
    Work queue IDs (UUID) to search for (work queues with any matching UUID are returned)
    WorkspaceId string
    Workspace ID (UUID), defaults to the workspace set in the provider
    id String
    The provider-assigned unique ID for this managed resource.
    workPoolName String
    Name of the associated work pool
    workQueues List<GetWorkQueuesWorkQueue>
    Work queues returned by the server
    accountId String
    Account ID (UUID), defaults to the account set in the provider
    filterAnies List<String>
    Work queue IDs (UUID) to search for (work queues with any matching UUID are returned)
    workspaceId String
    Workspace ID (UUID), defaults to the workspace set in the provider
    id string
    The provider-assigned unique ID for this managed resource.
    workPoolName string
    Name of the associated work pool
    workQueues GetWorkQueuesWorkQueue[]
    Work queues returned by the server
    accountId string
    Account ID (UUID), defaults to the account set in the provider
    filterAnies string[]
    Work queue IDs (UUID) to search for (work queues with any matching UUID are returned)
    workspaceId string
    Workspace ID (UUID), defaults to the workspace set in the provider
    id str
    The provider-assigned unique ID for this managed resource.
    work_pool_name str
    Name of the associated work pool
    work_queues Sequence[GetWorkQueuesWorkQueue]
    Work queues returned by the server
    account_id str
    Account ID (UUID), defaults to the account set in the provider
    filter_anies Sequence[str]
    Work queue IDs (UUID) to search for (work queues with any matching UUID are returned)
    workspace_id str
    Workspace ID (UUID), defaults to the workspace set in the provider
    id String
    The provider-assigned unique ID for this managed resource.
    workPoolName String
    Name of the associated work pool
    workQueues List<Property Map>
    Work queues returned by the server
    accountId String
    Account ID (UUID), defaults to the account set in the provider
    filterAnies List<String>
    Work queue IDs (UUID) to search for (work queues with any matching UUID are returned)
    workspaceId String
    Workspace ID (UUID), defaults to the workspace set in the provider

    Supporting Types

    GetWorkQueuesWorkQueue

    ConcurrencyLimit double
    The concurrency limit applied to this work queue
    Created string
    Date and time of the work queue creation in RFC 3339 format
    Description string
    Description of the work queue
    Id string
    Work queue ID (UUID)
    IsPaused bool
    Whether this work queue is paused
    Name string
    Name of the work queue
    Priority double
    Priority of the work queue
    Updated string
    Date and time that the work queue was last updated in RFC 3339 format
    WorkPoolName string
    Name of the associated work pool
    ConcurrencyLimit float64
    The concurrency limit applied to this work queue
    Created string
    Date and time of the work queue creation in RFC 3339 format
    Description string
    Description of the work queue
    Id string
    Work queue ID (UUID)
    IsPaused bool
    Whether this work queue is paused
    Name string
    Name of the work queue
    Priority float64
    Priority of the work queue
    Updated string
    Date and time that the work queue was last updated in RFC 3339 format
    WorkPoolName string
    Name of the associated work pool
    concurrencyLimit Double
    The concurrency limit applied to this work queue
    created String
    Date and time of the work queue creation in RFC 3339 format
    description String
    Description of the work queue
    id String
    Work queue ID (UUID)
    isPaused Boolean
    Whether this work queue is paused
    name String
    Name of the work queue
    priority Double
    Priority of the work queue
    updated String
    Date and time that the work queue was last updated in RFC 3339 format
    workPoolName String
    Name of the associated work pool
    concurrencyLimit number
    The concurrency limit applied to this work queue
    created string
    Date and time of the work queue creation in RFC 3339 format
    description string
    Description of the work queue
    id string
    Work queue ID (UUID)
    isPaused boolean
    Whether this work queue is paused
    name string
    Name of the work queue
    priority number
    Priority of the work queue
    updated string
    Date and time that the work queue was last updated in RFC 3339 format
    workPoolName string
    Name of the associated work pool
    concurrency_limit float
    The concurrency limit applied to this work queue
    created str
    Date and time of the work queue creation in RFC 3339 format
    description str
    Description of the work queue
    id str
    Work queue ID (UUID)
    is_paused bool
    Whether this work queue is paused
    name str
    Name of the work queue
    priority float
    Priority of the work queue
    updated str
    Date and time that the work queue was last updated in RFC 3339 format
    work_pool_name str
    Name of the associated work pool
    concurrencyLimit Number
    The concurrency limit applied to this work queue
    created String
    Date and time of the work queue creation in RFC 3339 format
    description String
    Description of the work queue
    id String
    Work queue ID (UUID)
    isPaused Boolean
    Whether this work queue is paused
    name String
    Name of the work queue
    priority Number
    Priority of the work queue
    updated String
    Date and time that the work queue was last updated in RFC 3339 format
    workPoolName String
    Name of the associated work pool

    Package Details

    Repository
    prefect prefecthq/terraform-provider-prefect
    License
    Notes
    This Pulumi package is based on the prefect Terraform Provider.
    prefect logo
    prefect 2.26.1 published on Friday, May 9, 2025 by prefecthq
    prefecthq/terraform-provider-prefect