AWS Classic v5.41.0, May 15 23
AWS Classic v5.41.0, May 15 23
aws.connect.getQueue
Explore with Pulumi AI
Provides details about a specific Amazon Connect Queue.
Example Usage
By
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 main
import (
"github.com/pulumi/pulumi-aws/sdk/v5/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
})
}
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());
}
}
import pulumi
import pulumi_aws as aws
example = aws.connect.get_queue(instance_id="aaaaaaaa-bbbb-cccc-dddd-111111111111",
name="Example")
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",
});
variables:
example:
fn::invoke:
Function: aws:connect:getQueue
Arguments:
instanceId: aaaaaaaa-bbbb-cccc-dddd-111111111111
name: Example
queue_id
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 main
import (
"github.com/pulumi/pulumi-aws/sdk/v5/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
})
}
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());
}
}
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")
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",
});
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)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aws:connect/getQueue:getQueue
arguments:
# arguments dictionary
The following arguments are supported:
- Instance
Id string Reference to the hosting Amazon Connect Instance
- Name string
Returns information on a specific Queue by name
- Queue
Id string Returns information on a specific Queue by Queue id
- Dictionary<string, string>
Map of tags assigned to the Queue.
- Instance
Id string Reference to the hosting Amazon Connect Instance
- Name string
Returns information on a specific Queue by name
- Queue
Id string Returns information on a specific Queue by Queue id
- map[string]string
Map of tags assigned to the Queue.
- instance
Id String Reference to the hosting Amazon Connect Instance
- name String
Returns information on a specific Queue by name
- queue
Id String Returns information on a specific Queue by Queue id
- Map<String,String>
Map of tags assigned to the Queue.
- instance
Id string Reference to the hosting Amazon Connect Instance
- name string
Returns information on a specific Queue by name
- queue
Id string Returns information on a specific Queue by Queue id
- {[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
- Mapping[str, str]
Map of tags assigned to the Queue.
- instance
Id String Reference to the hosting Amazon Connect Instance
- name String
Returns information on a specific Queue by name
- queue
Id String Returns information on a specific Queue by Queue id
- 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.
- Hours
Of stringOperation Id Specifies the identifier of the Hours of Operation.
- Id string
The provider-assigned unique ID for this managed resource.
- Instance
Id string - Max
Contacts int Maximum number of contacts that can be in the queue before it is considered full. Minimum value of 0.
- Name string
- Outbound
Caller List<GetConfigs Queue Outbound Caller Config> A block that defines the outbound caller ID name, number, and outbound whisper flow. The Outbound Caller Config block is documented below.
- Queue
Id string Identifier for the Queue.
- Status string
Description of the Queue. Values are
ENABLED
orDISABLED
.- Dictionary<string, string>
Map of tags assigned to the Queue.
- Arn string
ARN of the Queue.
- Description string
Description of the Queue.
- Hours
Of stringOperation Id Specifies the identifier of the Hours of Operation.
- Id string
The provider-assigned unique ID for this managed resource.
- Instance
Id string - Max
Contacts int Maximum number of contacts that can be in the queue before it is considered full. Minimum value of 0.
- Name string
- Outbound
Caller []GetConfigs Queue Outbound Caller Config A block that defines the outbound caller ID name, number, and outbound whisper flow. The Outbound Caller Config block is documented below.
- Queue
Id string Identifier for the Queue.
- Status string
Description of the Queue. Values are
ENABLED
orDISABLED
.- map[string]string
Map of tags assigned to the Queue.
- arn String
ARN of the Queue.
- description String
Description of the Queue.
- hours
Of StringOperation Id Specifies the identifier of the Hours of Operation.
- id String
The provider-assigned unique ID for this managed resource.
- instance
Id String - max
Contacts Integer Maximum number of contacts that can be in the queue before it is considered full. Minimum value of 0.
- name String
- outbound
Caller List<GetConfigs Queue Outbound Caller Config> A block that defines the outbound caller ID name, number, and outbound whisper flow. The Outbound Caller Config block is documented below.
- queue
Id String Identifier for the Queue.
- status String
Description of the Queue. Values are
ENABLED
orDISABLED
.- Map<String,String>
Map of tags assigned to the Queue.
- arn string
ARN of the Queue.
- description string
Description of the Queue.
- hours
Of stringOperation Id Specifies the identifier of the Hours of Operation.
- id string
The provider-assigned unique ID for this managed resource.
- instance
Id string - max
Contacts number Maximum number of contacts that can be in the queue before it is considered full. Minimum value of 0.
- name string
- outbound
Caller GetConfigs Queue Outbound Caller Config[] A block that defines the outbound caller ID name, number, and outbound whisper flow. The Outbound Caller Config block is documented below.
- queue
Id string Identifier for the Queue.
- status string
Description of the Queue. Values are
ENABLED
orDISABLED
.- {[key: string]: string}
Map of tags assigned to the Queue.
- arn str
ARN of the Queue.
- description str
Description of the Queue.
- hours_
of_ stroperation_ id 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_ Sequence[Getconfigs Queue Outbound Caller Config] 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
orDISABLED
.- Mapping[str, str]
Map of tags assigned to the Queue.
- arn String
ARN of the Queue.
- description String
Description of the Queue.
- hours
Of StringOperation Id Specifies the identifier of the Hours of Operation.
- id String
The provider-assigned unique ID for this managed resource.
- instance
Id String - max
Contacts Number Maximum number of contacts that can be in the queue before it is considered full. Minimum value of 0.
- name String
- outbound
Caller List<Property Map>Configs A block that defines the outbound caller ID name, number, and outbound whisper flow. The Outbound Caller Config block is documented below.
- queue
Id String Identifier for the Queue.
- status String
Description of the Queue. Values are
ENABLED
orDISABLED
.- Map<String>
Map of tags assigned to the Queue.
Supporting Types
GetQueueOutboundCallerConfig
- Outbound
Caller stringId Name Specifies the caller ID name.
- Outbound
Caller stringId Number Id Specifies the caller ID number.
- Outbound
Flow stringId Outbound whisper flow to be used during an outbound call.
- Outbound
Caller stringId Name Specifies the caller ID name.
- Outbound
Caller stringId Number Id Specifies the caller ID number.
- Outbound
Flow stringId Outbound whisper flow to be used during an outbound call.
- outbound
Caller StringId Name Specifies the caller ID name.
- outbound
Caller StringId Number Id Specifies the caller ID number.
- outbound
Flow StringId Outbound whisper flow to be used during an outbound call.
- outbound
Caller stringId Name Specifies the caller ID name.
- outbound
Caller stringId Number Id Specifies the caller ID number.
- outbound
Flow stringId Outbound whisper flow to be used during an outbound call.
- outbound_
caller_ strid_ name Specifies the caller ID name.
- outbound_
caller_ strid_ number_ id Specifies the caller ID number.
- outbound_
flow_ strid Outbound whisper flow to be used during an outbound call.
- outbound
Caller StringId Name Specifies the caller ID name.
- outbound
Caller StringId Number Id Specifies the caller ID number.
- outbound
Flow StringId 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.