1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. message
  5. getServiceQueues
Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi

alicloud.message.getServiceQueues

Explore with Pulumi AI

Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi

This data source provides the Message Notification Service Queues of the current Alibaba Cloud user.

NOTE: Available in v1.188.0+.

Example Usage

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

const ids = alicloud.message.getServiceQueues({
    ids: ["example_id"],
});
export const queueId1 = ids.then(ids => ids.queues?.[0]?.id);
const name = alicloud.message.getServiceQueues({
    queueName: "tf-example",
});
export const queueId2 = name.then(name => name.queues?.[0]?.id);
Copy
import pulumi
import pulumi_alicloud as alicloud

ids = alicloud.message.get_service_queues(ids=["example_id"])
pulumi.export("queueId1", ids.queues[0].id)
name = alicloud.message.get_service_queues(queue_name="tf-example")
pulumi.export("queueId2", name.queues[0].id)
Copy
package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/message"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		ids, err := message.GetServiceQueues(ctx, &message.GetServiceQueuesArgs{
			Ids: []string{
				"example_id",
			},
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("queueId1", ids.Queues[0].Id)
		name, err := message.GetServiceQueues(ctx, &message.GetServiceQueuesArgs{
			QueueName: pulumi.StringRef("tf-example"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("queueId2", name.Queues[0].Id)
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;

return await Deployment.RunAsync(() => 
{
    var ids = AliCloud.Message.GetServiceQueues.Invoke(new()
    {
        Ids = new[]
        {
            "example_id",
        },
    });

    var name = AliCloud.Message.GetServiceQueues.Invoke(new()
    {
        QueueName = "tf-example",
    });

    return new Dictionary<string, object?>
    {
        ["queueId1"] = ids.Apply(getServiceQueuesResult => getServiceQueuesResult.Queues[0]?.Id),
        ["queueId2"] = name.Apply(getServiceQueuesResult => getServiceQueuesResult.Queues[0]?.Id),
    };
});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.message.MessageFunctions;
import com.pulumi.alicloud.message.inputs.GetServiceQueuesArgs;
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 ids = MessageFunctions.getServiceQueues(GetServiceQueuesArgs.builder()
            .ids("example_id")
            .build());

        ctx.export("queueId1", ids.applyValue(getServiceQueuesResult -> getServiceQueuesResult.queues()[0].id()));
        final var name = MessageFunctions.getServiceQueues(GetServiceQueuesArgs.builder()
            .queueName("tf-example")
            .build());

        ctx.export("queueId2", name.applyValue(getServiceQueuesResult -> getServiceQueuesResult.queues()[0].id()));
    }
}
Copy
variables:
  ids:
    fn::invoke:
      function: alicloud:message:getServiceQueues
      arguments:
        ids:
          - example_id
  name:
    fn::invoke:
      function: alicloud:message:getServiceQueues
      arguments:
        queueName: tf-example
outputs:
  queueId1: ${ids.queues[0].id}
  queueId2: ${name.queues[0].id}
Copy

Using getServiceQueues

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 getServiceQueues(args: GetServiceQueuesArgs, opts?: InvokeOptions): Promise<GetServiceQueuesResult>
function getServiceQueuesOutput(args: GetServiceQueuesOutputArgs, opts?: InvokeOptions): Output<GetServiceQueuesResult>
Copy
def get_service_queues(ids: Optional[Sequence[str]] = None,
                       name_regex: Optional[str] = None,
                       output_file: Optional[str] = None,
                       page_number: Optional[int] = None,
                       page_size: Optional[int] = None,
                       queue_name: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetServiceQueuesResult
def get_service_queues_output(ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                       name_regex: Optional[pulumi.Input[str]] = None,
                       output_file: Optional[pulumi.Input[str]] = None,
                       page_number: Optional[pulumi.Input[int]] = None,
                       page_size: Optional[pulumi.Input[int]] = None,
                       queue_name: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetServiceQueuesResult]
Copy
func GetServiceQueues(ctx *Context, args *GetServiceQueuesArgs, opts ...InvokeOption) (*GetServiceQueuesResult, error)
func GetServiceQueuesOutput(ctx *Context, args *GetServiceQueuesOutputArgs, opts ...InvokeOption) GetServiceQueuesResultOutput
Copy

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

public static class GetServiceQueues 
{
    public static Task<GetServiceQueuesResult> InvokeAsync(GetServiceQueuesArgs args, InvokeOptions? opts = null)
    public static Output<GetServiceQueuesResult> Invoke(GetServiceQueuesInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetServiceQueuesResult> getServiceQueues(GetServiceQueuesArgs args, InvokeOptions options)
public static Output<GetServiceQueuesResult> getServiceQueues(GetServiceQueuesArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: alicloud:message/getServiceQueues:getServiceQueues
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Ids Changes to this property will trigger replacement. List<string>
A list of Queue IDs. Its element value is same as Queue Name.
NameRegex Changes to this property will trigger replacement. string
A regex string to filter results by Queue name.
OutputFile string
File name where to save data source results (after running pulumi preview).
PageNumber int
PageSize int
QueueName Changes to this property will trigger replacement. string
The name of the queue.
Ids Changes to this property will trigger replacement. []string
A list of Queue IDs. Its element value is same as Queue Name.
NameRegex Changes to this property will trigger replacement. string
A regex string to filter results by Queue name.
OutputFile string
File name where to save data source results (after running pulumi preview).
PageNumber int
PageSize int
QueueName Changes to this property will trigger replacement. string
The name of the queue.
ids Changes to this property will trigger replacement. List<String>
A list of Queue IDs. Its element value is same as Queue Name.
nameRegex Changes to this property will trigger replacement. String
A regex string to filter results by Queue name.
outputFile String
File name where to save data source results (after running pulumi preview).
pageNumber Integer
pageSize Integer
queueName Changes to this property will trigger replacement. String
The name of the queue.
ids Changes to this property will trigger replacement. string[]
A list of Queue IDs. Its element value is same as Queue Name.
nameRegex Changes to this property will trigger replacement. string
A regex string to filter results by Queue name.
outputFile string
File name where to save data source results (after running pulumi preview).
pageNumber number
pageSize number
queueName Changes to this property will trigger replacement. string
The name of the queue.
ids Changes to this property will trigger replacement. Sequence[str]
A list of Queue IDs. Its element value is same as Queue Name.
name_regex Changes to this property will trigger replacement. str
A regex string to filter results by Queue name.
output_file str
File name where to save data source results (after running pulumi preview).
page_number int
page_size int
queue_name Changes to this property will trigger replacement. str
The name of the queue.
ids Changes to this property will trigger replacement. List<String>
A list of Queue IDs. Its element value is same as Queue Name.
nameRegex Changes to this property will trigger replacement. String
A regex string to filter results by Queue name.
outputFile String
File name where to save data source results (after running pulumi preview).
pageNumber Number
pageSize Number
queueName Changes to this property will trigger replacement. String
The name of the queue.

getServiceQueues Result

The following output properties are available:

Id string
The provider-assigned unique ID for this managed resource.
Ids List<string>
Names List<string>
A list of Queue names.
Queues List<Pulumi.AliCloud.Message.Outputs.GetServiceQueuesQueue>
A list of Queues. Each element contains the following attributes:
NameRegex string
OutputFile string
PageNumber int
PageSize int
QueueName string
The name of the queue.
Id string
The provider-assigned unique ID for this managed resource.
Ids []string
Names []string
A list of Queue names.
Queues []GetServiceQueuesQueue
A list of Queues. Each element contains the following attributes:
NameRegex string
OutputFile string
PageNumber int
PageSize int
QueueName string
The name of the queue.
id String
The provider-assigned unique ID for this managed resource.
ids List<String>
names List<String>
A list of Queue names.
queues List<GetServiceQueuesQueue>
A list of Queues. Each element contains the following attributes:
nameRegex String
outputFile String
pageNumber Integer
pageSize Integer
queueName String
The name of the queue.
id string
The provider-assigned unique ID for this managed resource.
ids string[]
names string[]
A list of Queue names.
queues GetServiceQueuesQueue[]
A list of Queues. Each element contains the following attributes:
nameRegex string
outputFile string
pageNumber number
pageSize number
queueName string
The name of the queue.
id str
The provider-assigned unique ID for this managed resource.
ids Sequence[str]
names Sequence[str]
A list of Queue names.
queues Sequence[GetServiceQueuesQueue]
A list of Queues. Each element contains the following attributes:
name_regex str
output_file str
page_number int
page_size int
queue_name str
The name of the queue.
id String
The provider-assigned unique ID for this managed resource.
ids List<String>
names List<String>
A list of Queue names.
queues List<Property Map>
A list of Queues. Each element contains the following attributes:
nameRegex String
outputFile String
pageNumber Number
pageSize Number
queueName String
The name of the queue.

Supporting Types

GetServiceQueuesQueue

ActiveMessages This property is required. int
The total number of messages that are in the Active state in the queue. The value is an approximate number.
CreateTime This property is required. int
The time when the queue was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.
DelayMessages This property is required. int
The total number of the messages that are in the Delayed state in the queue. The value is an approximate number.
DelaySeconds This property is required. int
The delay period after which all messages that are sent to the queue can be consumed. Unit: seconds.
Id This property is required. string
The ID of the Queue. Its value is same as Queue Name.
InactiveMessages This property is required. int
The total number of the messages that are in the Inactive state in the queue. The value is an approximate number.
LastModifyTime This property is required. int
The time when the queue was last modified. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.
LoggingEnabled This property is required. bool
Indicates whether the log management feature is enabled for the queue.
MaximumMessageSize This property is required. int
The maximum size of a message body that can be sent to the queue. Unit: bytes.
MessageRetentionPeriod This property is required. int
The maximum period for which a message can be retained in the queue. A message that is sent to the queue can be retained for a specified period. After the specified period ends, the message is deleted no matter whether it is consumed. Unit: seconds.
PollingWaitSeconds This property is required. int
The maximum period for which a ReceiveMessage request waits if no message is available in the queue. Unit: seconds.
QueueInternalUrl This property is required. string
The internal url of the queue.
QueueName This property is required. string
The name of the queue.
QueueUrl This property is required. string
The url of the queue.
VisibilityTimeout This property is required. int
The invisibility period for which the received message remains the Inactive state. Unit: seconds.
ActiveMessages This property is required. int
The total number of messages that are in the Active state in the queue. The value is an approximate number.
CreateTime This property is required. int
The time when the queue was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.
DelayMessages This property is required. int
The total number of the messages that are in the Delayed state in the queue. The value is an approximate number.
DelaySeconds This property is required. int
The delay period after which all messages that are sent to the queue can be consumed. Unit: seconds.
Id This property is required. string
The ID of the Queue. Its value is same as Queue Name.
InactiveMessages This property is required. int
The total number of the messages that are in the Inactive state in the queue. The value is an approximate number.
LastModifyTime This property is required. int
The time when the queue was last modified. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.
LoggingEnabled This property is required. bool
Indicates whether the log management feature is enabled for the queue.
MaximumMessageSize This property is required. int
The maximum size of a message body that can be sent to the queue. Unit: bytes.
MessageRetentionPeriod This property is required. int
The maximum period for which a message can be retained in the queue. A message that is sent to the queue can be retained for a specified period. After the specified period ends, the message is deleted no matter whether it is consumed. Unit: seconds.
PollingWaitSeconds This property is required. int
The maximum period for which a ReceiveMessage request waits if no message is available in the queue. Unit: seconds.
QueueInternalUrl This property is required. string
The internal url of the queue.
QueueName This property is required. string
The name of the queue.
QueueUrl This property is required. string
The url of the queue.
VisibilityTimeout This property is required. int
The invisibility period for which the received message remains the Inactive state. Unit: seconds.
activeMessages This property is required. Integer
The total number of messages that are in the Active state in the queue. The value is an approximate number.
createTime This property is required. Integer
The time when the queue was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.
delayMessages This property is required. Integer
The total number of the messages that are in the Delayed state in the queue. The value is an approximate number.
delaySeconds This property is required. Integer
The delay period after which all messages that are sent to the queue can be consumed. Unit: seconds.
id This property is required. String
The ID of the Queue. Its value is same as Queue Name.
inactiveMessages This property is required. Integer
The total number of the messages that are in the Inactive state in the queue. The value is an approximate number.
lastModifyTime This property is required. Integer
The time when the queue was last modified. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.
loggingEnabled This property is required. Boolean
Indicates whether the log management feature is enabled for the queue.
maximumMessageSize This property is required. Integer
The maximum size of a message body that can be sent to the queue. Unit: bytes.
messageRetentionPeriod This property is required. Integer
The maximum period for which a message can be retained in the queue. A message that is sent to the queue can be retained for a specified period. After the specified period ends, the message is deleted no matter whether it is consumed. Unit: seconds.
pollingWaitSeconds This property is required. Integer
The maximum period for which a ReceiveMessage request waits if no message is available in the queue. Unit: seconds.
queueInternalUrl This property is required. String
The internal url of the queue.
queueName This property is required. String
The name of the queue.
queueUrl This property is required. String
The url of the queue.
visibilityTimeout This property is required. Integer
The invisibility period for which the received message remains the Inactive state. Unit: seconds.
activeMessages This property is required. number
The total number of messages that are in the Active state in the queue. The value is an approximate number.
createTime This property is required. number
The time when the queue was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.
delayMessages This property is required. number
The total number of the messages that are in the Delayed state in the queue. The value is an approximate number.
delaySeconds This property is required. number
The delay period after which all messages that are sent to the queue can be consumed. Unit: seconds.
id This property is required. string
The ID of the Queue. Its value is same as Queue Name.
inactiveMessages This property is required. number
The total number of the messages that are in the Inactive state in the queue. The value is an approximate number.
lastModifyTime This property is required. number
The time when the queue was last modified. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.
loggingEnabled This property is required. boolean
Indicates whether the log management feature is enabled for the queue.
maximumMessageSize This property is required. number
The maximum size of a message body that can be sent to the queue. Unit: bytes.
messageRetentionPeriod This property is required. number
The maximum period for which a message can be retained in the queue. A message that is sent to the queue can be retained for a specified period. After the specified period ends, the message is deleted no matter whether it is consumed. Unit: seconds.
pollingWaitSeconds This property is required. number
The maximum period for which a ReceiveMessage request waits if no message is available in the queue. Unit: seconds.
queueInternalUrl This property is required. string
The internal url of the queue.
queueName This property is required. string
The name of the queue.
queueUrl This property is required. string
The url of the queue.
visibilityTimeout This property is required. number
The invisibility period for which the received message remains the Inactive state. Unit: seconds.
active_messages This property is required. int
The total number of messages that are in the Active state in the queue. The value is an approximate number.
create_time This property is required. int
The time when the queue was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.
delay_messages This property is required. int
The total number of the messages that are in the Delayed state in the queue. The value is an approximate number.
delay_seconds This property is required. int
The delay period after which all messages that are sent to the queue can be consumed. Unit: seconds.
id This property is required. str
The ID of the Queue. Its value is same as Queue Name.
inactive_messages This property is required. int
The total number of the messages that are in the Inactive state in the queue. The value is an approximate number.
last_modify_time This property is required. int
The time when the queue was last modified. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.
logging_enabled This property is required. bool
Indicates whether the log management feature is enabled for the queue.
maximum_message_size This property is required. int
The maximum size of a message body that can be sent to the queue. Unit: bytes.
message_retention_period This property is required. int
The maximum period for which a message can be retained in the queue. A message that is sent to the queue can be retained for a specified period. After the specified period ends, the message is deleted no matter whether it is consumed. Unit: seconds.
polling_wait_seconds This property is required. int
The maximum period for which a ReceiveMessage request waits if no message is available in the queue. Unit: seconds.
queue_internal_url This property is required. str
The internal url of the queue.
queue_name This property is required. str
The name of the queue.
queue_url This property is required. str
The url of the queue.
visibility_timeout This property is required. int
The invisibility period for which the received message remains the Inactive state. Unit: seconds.
activeMessages This property is required. Number
The total number of messages that are in the Active state in the queue. The value is an approximate number.
createTime This property is required. Number
The time when the queue was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.
delayMessages This property is required. Number
The total number of the messages that are in the Delayed state in the queue. The value is an approximate number.
delaySeconds This property is required. Number
The delay period after which all messages that are sent to the queue can be consumed. Unit: seconds.
id This property is required. String
The ID of the Queue. Its value is same as Queue Name.
inactiveMessages This property is required. Number
The total number of the messages that are in the Inactive state in the queue. The value is an approximate number.
lastModifyTime This property is required. Number
The time when the queue was last modified. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.
loggingEnabled This property is required. Boolean
Indicates whether the log management feature is enabled for the queue.
maximumMessageSize This property is required. Number
The maximum size of a message body that can be sent to the queue. Unit: bytes.
messageRetentionPeriod This property is required. Number
The maximum period for which a message can be retained in the queue. A message that is sent to the queue can be retained for a specified period. After the specified period ends, the message is deleted no matter whether it is consumed. Unit: seconds.
pollingWaitSeconds This property is required. Number
The maximum period for which a ReceiveMessage request waits if no message is available in the queue. Unit: seconds.
queueInternalUrl This property is required. String
The internal url of the queue.
queueName This property is required. String
The name of the queue.
queueUrl This property is required. String
The url of the queue.
visibilityTimeout This property is required. Number
The invisibility period for which the received message remains the Inactive state. Unit: seconds.

Package Details

Repository
Alibaba Cloud pulumi/pulumi-alicloud
License
Apache-2.0
Notes
This Pulumi package is based on the alicloud Terraform Provider.
Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi