AWS v6.71.0, Mar 7 25

AWS v6.71.0 published on Friday, Mar 7, 2025 by Pulumi

aws.connect.getQueue

Explore with Pulumi AI

AWS v6.71.0 published on Friday, Mar 7, 2025 by Pulumi

pulumi/pulumi-aws

Example Usage

By name

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

const example = aws.connect.getQueue({
    instanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
    name: "Example",
});

import pulumi
import pulumi_aws as aws

example = aws.connect.get_queue(instance_id="aaaaaaaa-bbbb-cccc-dddd-111111111111",
    name="Example")

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/connect"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := connect.LookupQueue(ctx, &connect.LookupQueueArgs{
			InstanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
			Name:       pulumi.StringRef("Example"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = Aws.Connect.GetQueue.Invoke(new()
    {
        InstanceId = "aaaaaaaa-bbbb-cccc-dddd-111111111111",
        Name = "Example",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.connect.ConnectFunctions;
import com.pulumi.aws.connect.inputs.GetQueueArgs;
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 example = ConnectFunctions.getQueue(GetQueueArgs.builder()
            .instanceId("aaaaaaaa-bbbb-cccc-dddd-111111111111")
            .name("Example")
            .build());

    }
}

variables:
  example:
    fn::invoke:
      function: aws:connect:getQueue
      arguments:
        instanceId: aaaaaaaa-bbbb-cccc-dddd-111111111111
        name: Example

By queue_id

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

const example = aws.connect.getQueue({
    instanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
    queueId: "cccccccc-bbbb-cccc-dddd-111111111111",
});

import pulumi
import pulumi_aws as aws

example = aws.connect.get_queue(instance_id="aaaaaaaa-bbbb-cccc-dddd-111111111111",
    queue_id="cccccccc-bbbb-cccc-dddd-111111111111")

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/connect"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := connect.LookupQueue(ctx, &connect.LookupQueueArgs{
			InstanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
			QueueId:    pulumi.StringRef("cccccccc-bbbb-cccc-dddd-111111111111"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = Aws.Connect.GetQueue.Invoke(new()
    {
        InstanceId = "aaaaaaaa-bbbb-cccc-dddd-111111111111",
        QueueId = "cccccccc-bbbb-cccc-dddd-111111111111",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.connect.ConnectFunctions;
import com.pulumi.aws.connect.inputs.GetQueueArgs;
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 example = ConnectFunctions.getQueue(GetQueueArgs.builder()
            .instanceId("aaaaaaaa-bbbb-cccc-dddd-111111111111")
            .queueId("cccccccc-bbbb-cccc-dddd-111111111111")
            .build());

    }
}

variables:
  example:
    fn::invoke:
      function: aws:connect:getQueue
      arguments:
        instanceId: aaaaaaaa-bbbb-cccc-dddd-111111111111
        queueId: cccccccc-bbbb-cccc-dddd-111111111111

Using getQueue

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 getQueue(args: GetQueueArgs, opts?: InvokeOptions): Promise<GetQueueResult>
function getQueueOutput(args: GetQueueOutputArgs, opts?: InvokeOptions): Output<GetQueueResult>

def get_queue(instance_id: Optional[str] = None,
              name: Optional[str] = None,
              queue_id: Optional[str] = None,
              tags: Optional[Mapping[str, str]] = None,
              opts: Optional[InvokeOptions] = None) -> GetQueueResult
def get_queue_output(instance_id: Optional[pulumi.Input[str]] = None,
              name: Optional[pulumi.Input[str]] = None,
              queue_id: Optional[pulumi.Input[str]] = None,
              tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetQueueResult]

func LookupQueue(ctx *Context, args *LookupQueueArgs, opts ...InvokeOption) (*LookupQueueResult, error)
func LookupQueueOutput(ctx *Context, args *LookupQueueOutputArgs, opts ...InvokeOption) LookupQueueResultOutput

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

public static class GetQueue 
{
    public static Task<GetQueueResult> InvokeAsync(GetQueueArgs args, InvokeOptions? opts = null)
    public static Output<GetQueueResult> Invoke(GetQueueInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetQueueResult> getQueue(GetQueueArgs args, InvokeOptions options)
public static Output<GetQueueResult> getQueue(GetQueueArgs args, InvokeOptions options)

fn::invoke:
  function: aws:connect/getQueue:getQueue
  arguments:
    # arguments dictionary

The following arguments are supported:

InstanceId string: Reference to the hosting Amazon Connect Instance
Name string: Returns information on a specific Queue by name
QueueId string: Returns information on a specific Queue by Queue id
Tags Dictionary<string, string>: Map of tags assigned to the Queue.

InstanceId string: Reference to the hosting Amazon Connect Instance
Name string: Returns information on a specific Queue by name
QueueId string: Returns information on a specific Queue by Queue id
Tags map[string]string: Map of tags assigned to the Queue.

instanceId String: Reference to the hosting Amazon Connect Instance
name String: Returns information on a specific Queue by name
queueId String: Returns information on a specific Queue by Queue id
tags Map<String,String>: Map of tags assigned to the Queue.

instanceId string: Reference to the hosting Amazon Connect Instance
name string: Returns information on a specific Queue by name
queueId string: Returns information on a specific Queue by Queue id
tags {[key: string]: string}: Map of tags assigned to the Queue.

instance_id str: Reference to the hosting Amazon Connect Instance
name str: Returns information on a specific Queue by name
queue_id str: Returns information on a specific Queue by Queue id
tags Mapping[str, str]: Map of tags assigned to the Queue.

instanceId String: Reference to the hosting Amazon Connect Instance
name String: Returns information on a specific Queue by name
queueId String: Returns information on a specific Queue by Queue id
tags Map<String>: Map of tags assigned to the Queue.

getQueue Result

The following output properties are available:

Arn string: ARN of the Queue.
Description string: Description of the Queue.
HoursOfOperationId string: Specifies the identifier of the Hours of Operation.
Id string: The provider-assigned unique ID for this managed resource.
InstanceId string
MaxContacts int: Maximum number of contacts that can be in the queue before it is considered full. Minimum value of 0.
Name string
OutboundCallerConfigs List<GetQueueOutboundCallerConfig>: A block that defines the outbound caller ID name, number, and outbound whisper flow. The Outbound Caller Config block is documented below.
QueueId string: Identifier for the Queue.
Status string: Description of the Queue. Values are ENABLED or DISABLED.
Tags Dictionary<string, string>: Map of tags assigned to the Queue.

Arn string: ARN of the Queue.
Description string: Description of the Queue.
HoursOfOperationId string: Specifies the identifier of the Hours of Operation.
Id string: The provider-assigned unique ID for this managed resource.
InstanceId string
MaxContacts int: Maximum number of contacts that can be in the queue before it is considered full. Minimum value of 0.
Name string
OutboundCallerConfigs []GetQueueOutboundCallerConfig: A block that defines the outbound caller ID name, number, and outbound whisper flow. The Outbound Caller Config block is documented below.
QueueId string: Identifier for the Queue.
Status string: Description of the Queue. Values are ENABLED or DISABLED.
Tags map[string]string: Map of tags assigned to the Queue.

arn String: ARN of the Queue.
description String: Description of the Queue.
hoursOfOperationId String: Specifies the identifier of the Hours of Operation.
id String: The provider-assigned unique ID for this managed resource.
instanceId String
maxContacts Integer: Maximum number of contacts that can be in the queue before it is considered full. Minimum value of 0.
name String
outboundCallerConfigs List<GetQueueOutboundCallerConfig>: A block that defines the outbound caller ID name, number, and outbound whisper flow. The Outbound Caller Config block is documented below.
queueId String: Identifier for the Queue.
status String: Description of the Queue. Values are ENABLED or DISABLED.
tags Map<String,String>: Map of tags assigned to the Queue.

arn string: ARN of the Queue.
description string: Description of the Queue.
hoursOfOperationId string: Specifies the identifier of the Hours of Operation.
id string: The provider-assigned unique ID for this managed resource.
instanceId string
maxContacts number: Maximum number of contacts that can be in the queue before it is considered full. Minimum value of 0.
name string
outboundCallerConfigs GetQueueOutboundCallerConfig[]: A block that defines the outbound caller ID name, number, and outbound whisper flow. The Outbound Caller Config block is documented below.
queueId string: Identifier for the Queue.
status string: Description of the Queue. Values are ENABLED or DISABLED.
tags {[key: string]: string}: Map of tags assigned to the Queue.

arn str: ARN of the Queue.
description str: Description of the Queue.
hours_of_operation_id str: Specifies the identifier of the Hours of Operation.
id str: The provider-assigned unique ID for this managed resource.
instance_id str
max_contacts int: Maximum number of contacts that can be in the queue before it is considered full. Minimum value of 0.
name str
outbound_caller_configs Sequence[GetQueueOutboundCallerConfig]: A block that defines the outbound caller ID name, number, and outbound whisper flow. The Outbound Caller Config block is documented below.
queue_id str: Identifier for the Queue.
status str: Description of the Queue. Values are ENABLED or DISABLED.
tags Mapping[str, str]: Map of tags assigned to the Queue.

arn String: ARN of the Queue.
description String: Description of the Queue.
hoursOfOperationId String: Specifies the identifier of the Hours of Operation.
id String: The provider-assigned unique ID for this managed resource.
instanceId String
maxContacts Number: Maximum number of contacts that can be in the queue before it is considered full. Minimum value of 0.
name String
outboundCallerConfigs List<Property Map>: A block that defines the outbound caller ID name, number, and outbound whisper flow. The Outbound Caller Config block is documented below.
queueId String: Identifier for the Queue.
status String: Description of the Queue. Values are ENABLED or DISABLED.
tags Map<String>: Map of tags assigned to the Queue.

Supporting Types

GetQueueOutboundCallerConfig

OutboundCallerIdName string: Specifies the caller ID name.
OutboundCallerIdNumberId string: Specifies the caller ID number.
OutboundFlowId string: Outbound whisper flow to be used during an outbound call.

OutboundCallerIdName string: Specifies the caller ID name.
OutboundCallerIdNumberId string: Specifies the caller ID number.
OutboundFlowId string: Outbound whisper flow to be used during an outbound call.

outboundCallerIdName String: Specifies the caller ID name.
outboundCallerIdNumberId String: Specifies the caller ID number.
outboundFlowId String: Outbound whisper flow to be used during an outbound call.

outboundCallerIdName string: Specifies the caller ID name.
outboundCallerIdNumberId string: Specifies the caller ID number.
outboundFlowId string: Outbound whisper flow to be used during an outbound call.

outbound_caller_id_name str: Specifies the caller ID name.
outbound_caller_id_number_id str: Specifies the caller ID number.
outbound_flow_id str: Outbound whisper flow to be used during an outbound call.

outboundCallerIdName String: Specifies the caller ID name.
outboundCallerIdNumberId String: Specifies the caller ID number.
outboundFlowId String: Outbound whisper flow to be used during an outbound call.

Package Details

Repository: AWS Classic pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

AWS v6.71.0 published on Friday, Mar 7, 2025 by Pulumi

pulumi/pulumi-aws

aws.connect.getQueue

On this page

On this page

Example Usage

Using getQueue

getQueue Result

Supporting Types

GetQueueOutboundCallerConfig

Package Details

On this page

On this page