菜单
开源

listQueues

SQSClient.listQueues(options) 检索可用 Amazon Simple Queue Service (SQS) 队列的列表。

参数

名称类型描述
optionsobject (可选)请求的选项。接受的属性有:queueNamePrefix (可选 string) 设置返回队列列表的前缀过滤器,maxResults (可选 number) 设置响应中包含的最大结果数 (1 <= maxResults <= 1000),以及 nextToken (可选 string) 设置分页令牌以请求下一组相关结果。

返回值

类型描述
Promise<object>一个 Promise,成功时返回一个包含 urls 属性的对象,该属性是一个队列 URL 数组;如果相关,还包含一个可选的 nextToken,其中包含要在下次请求中包含的分页令牌。

示例

JavaScript
import exec from 'k6/execution';

import {
  AWSConfig,
  SQSClient,
} from 'https://jslib.k6.io/aws/0.13.0/sqs.js';

const awsConfig = new AWSConfig({
  region: __ENV.AWS_REGION,
  accessKeyId: __ENV.AWS_ACCESS_KEY_ID,
  secretAccessKey: __ENV.AWS_SECRET_ACCESS_KEY,
  sessionToken: __ENV.AWS_SESSION_TOKEN,
});

const sqs = new SQSClient(awsConfig);
const testQueue = 'https://sqs.us-east-1.amazonaws.com/000000000/test-queue';

export default async function () {
  // List all queues in the AWS account
  const queuesResponse = await sqs.listQueues();

  // If our test queue does not exist, abort the execution.
  if (queuesResponse.urls.filter((q) => q === testQueue).length == 0) {
    exec.test.abort();
  }

  // Send message to test queue
  await sqs.sendMessage(testQueue, JSON.stringify({ value: '123' }));
}