Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. connect
  5. getQueue

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.connect.getQueue

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::Connect::Queue

    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(queue_arn: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetQueueResult
def get_queue_output(queue_arn: Optional[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-native:connect:getQueue
  arguments:
    # arguments dictionary

    The following arguments are supported:

    QueueArn string
    The Amazon Resource Name (ARN) for the queue.
    QueueArn string
    The Amazon Resource Name (ARN) for the queue.
    queueArn String
    The Amazon Resource Name (ARN) for the queue.
    queueArn string
    The Amazon Resource Name (ARN) for the queue.
    queue_arn str
    The Amazon Resource Name (ARN) for the queue.
    queueArn String
    The Amazon Resource Name (ARN) for the queue.

    getQueue Result

    The following output properties are available:

    Description string
    The description of the queue.
    HoursOfOperationArn string
    The identifier for the hours of operation.
    InstanceArn string
    The identifier of the Amazon Connect instance.
    MaxContacts int
    The maximum number of contacts that can be in the queue before it is considered full.
    Name string
    The name of the queue.
    OutboundCallerConfig Pulumi.AwsNative.Connect.Outputs.QueueOutboundCallerConfig
    The outbound caller ID name, number, and outbound whisper flow.
    QueueArn string
    The Amazon Resource Name (ARN) for the queue.
    QuickConnectArns List<string>
    The quick connects available to agents who are working the queue.
    Status Pulumi.AwsNative.Connect.QueueStatus
    The status of the queue.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    An array of key-value pairs to apply to this resource.
    Type Pulumi.AwsNative.Connect.QueueType
    The type of queue.
    Description string
    The description of the queue.
    HoursOfOperationArn string
    The identifier for the hours of operation.
    InstanceArn string
    The identifier of the Amazon Connect instance.
    MaxContacts int
    The maximum number of contacts that can be in the queue before it is considered full.
    Name string
    The name of the queue.
    OutboundCallerConfig QueueOutboundCallerConfig
    The outbound caller ID name, number, and outbound whisper flow.
    QueueArn string
    The Amazon Resource Name (ARN) for the queue.
    QuickConnectArns []string
    The quick connects available to agents who are working the queue.
    Status QueueStatus
    The status of the queue.
    Tags Tag
    An array of key-value pairs to apply to this resource.
    Type QueueType
    The type of queue.
    description String
    The description of the queue.
    hoursOfOperationArn String
    The identifier for the hours of operation.
    instanceArn String
    The identifier of the Amazon Connect instance.
    maxContacts Integer
    The maximum number of contacts that can be in the queue before it is considered full.
    name String
    The name of the queue.
    outboundCallerConfig QueueOutboundCallerConfig
    The outbound caller ID name, number, and outbound whisper flow.
    queueArn String
    The Amazon Resource Name (ARN) for the queue.
    quickConnectArns List<String>
    The quick connects available to agents who are working the queue.
    status QueueStatus
    The status of the queue.
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    type QueueType
    The type of queue.
    description string
    The description of the queue.
    hoursOfOperationArn string
    The identifier for the hours of operation.
    instanceArn string
    The identifier of the Amazon Connect instance.
    maxContacts number
    The maximum number of contacts that can be in the queue before it is considered full.
    name string
    The name of the queue.
    outboundCallerConfig QueueOutboundCallerConfig
    The outbound caller ID name, number, and outbound whisper flow.
    queueArn string
    The Amazon Resource Name (ARN) for the queue.
    quickConnectArns string[]
    The quick connects available to agents who are working the queue.
    status QueueStatus
    The status of the queue.
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    type QueueType
    The type of queue.
    description str
    The description of the queue.
    hours_of_operation_arn str
    The identifier for the hours of operation.
    instance_arn str
    The identifier of the Amazon Connect instance.
    max_contacts int
    The maximum number of contacts that can be in the queue before it is considered full.
    name str
    The name of the queue.
    outbound_caller_config QueueOutboundCallerConfig
    The outbound caller ID name, number, and outbound whisper flow.
    queue_arn str
    The Amazon Resource Name (ARN) for the queue.
    quick_connect_arns Sequence[str]
    The quick connects available to agents who are working the queue.
    status QueueStatus
    The status of the queue.
    tags Sequence[root_Tag]
    An array of key-value pairs to apply to this resource.
    type QueueType
    The type of queue.
    description String
    The description of the queue.
    hoursOfOperationArn String
    The identifier for the hours of operation.
    instanceArn String
    The identifier of the Amazon Connect instance.
    maxContacts Number
    The maximum number of contacts that can be in the queue before it is considered full.
    name String
    The name of the queue.
    outboundCallerConfig Property Map
    The outbound caller ID name, number, and outbound whisper flow.
    queueArn String
    The Amazon Resource Name (ARN) for the queue.
    quickConnectArns List<String>
    The quick connects available to agents who are working the queue.
    status "ENABLED" | "DISABLED"
    The status of the queue.
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.
    type "STANDARD" | "AGENT"
    The type of queue.

    Supporting Types

    QueueOutboundCallerConfig

    OutboundCallerIdName string
    The caller ID name.
    OutboundCallerIdNumberArn string

    The Amazon Resource Name (ARN) of the outbound caller ID number.

    Only use the phone number ARN format that doesn't contain instance in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid . This is the same ARN format that is returned when you create a phone number using CloudFormation , or when you call the ListPhoneNumbersV2 API.

    OutboundFlowArn string
    The Amazon Resource Name (ARN) of the outbound flow.
    OutboundCallerIdName string
    The caller ID name.
    OutboundCallerIdNumberArn string

    The Amazon Resource Name (ARN) of the outbound caller ID number.

    Only use the phone number ARN format that doesn't contain instance in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid . This is the same ARN format that is returned when you create a phone number using CloudFormation , or when you call the ListPhoneNumbersV2 API.

    OutboundFlowArn string
    The Amazon Resource Name (ARN) of the outbound flow.
    outboundCallerIdName String
    The caller ID name.
    outboundCallerIdNumberArn String

    The Amazon Resource Name (ARN) of the outbound caller ID number.

    Only use the phone number ARN format that doesn't contain instance in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid . This is the same ARN format that is returned when you create a phone number using CloudFormation , or when you call the ListPhoneNumbersV2 API.

    outboundFlowArn String
    The Amazon Resource Name (ARN) of the outbound flow.
    outboundCallerIdName string
    The caller ID name.
    outboundCallerIdNumberArn string

    The Amazon Resource Name (ARN) of the outbound caller ID number.

    Only use the phone number ARN format that doesn't contain instance in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid . This is the same ARN format that is returned when you create a phone number using CloudFormation , or when you call the ListPhoneNumbersV2 API.

    outboundFlowArn string
    The Amazon Resource Name (ARN) of the outbound flow.
    outbound_caller_id_name str
    The caller ID name.
    outbound_caller_id_number_arn str

    The Amazon Resource Name (ARN) of the outbound caller ID number.

    Only use the phone number ARN format that doesn't contain instance in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid . This is the same ARN format that is returned when you create a phone number using CloudFormation , or when you call the ListPhoneNumbersV2 API.

    outbound_flow_arn str
    The Amazon Resource Name (ARN) of the outbound flow.
    outboundCallerIdName String
    The caller ID name.
    outboundCallerIdNumberArn String

    The Amazon Resource Name (ARN) of the outbound caller ID number.

    Only use the phone number ARN format that doesn't contain instance in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid . This is the same ARN format that is returned when you create a phone number using CloudFormation , or when you call the ListPhoneNumbersV2 API.

    outboundFlowArn String
    The Amazon Resource Name (ARN) of the outbound flow.

    QueueStatus

    QueueType

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-aws-native