- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
GetQueueCommand
Retrieve the JSON for a specific queue.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { MediaConvertClient, GetQueueCommand } from "@aws-sdk/client-mediaconvert"; // ES Modules import
// const { MediaConvertClient, GetQueueCommand } = require("@aws-sdk/client-mediaconvert"); // CommonJS import
const client = new MediaConvertClient(config);
const input = { // GetQueueRequest
Name: "STRING_VALUE", // required
};
const command = new GetQueueCommand(input);
const response = await client.send(command);
// { // GetQueueResponse
// Queue: { // Queue
// Arn: "STRING_VALUE",
// ConcurrentJobs: Number("int"),
// CreatedAt: new Date("TIMESTAMP"),
// Description: "STRING_VALUE",
// LastUpdated: new Date("TIMESTAMP"),
// Name: "STRING_VALUE", // required
// PricingPlan: "ON_DEMAND" || "RESERVED",
// ProgressingJobsCount: Number("int"),
// ReservationPlan: { // ReservationPlan
// Commitment: "ONE_YEAR",
// ExpiresAt: new Date("TIMESTAMP"),
// PurchasedAt: new Date("TIMESTAMP"),
// RenewalType: "AUTO_RENEW" || "EXPIRE",
// ReservedSlots: Number("int"),
// Status: "ACTIVE" || "EXPIRED",
// },
// ServiceOverrides: [ // __listOfServiceOverride
// { // ServiceOverride
// Message: "STRING_VALUE",
// Name: "STRING_VALUE",
// OverrideValue: "STRING_VALUE",
// Value: "STRING_VALUE",
// },
// ],
// Status: "ACTIVE" || "PAUSED",
// SubmittedJobsCount: Number("int"),
// Type: "SYSTEM" || "CUSTOM",
// },
// };
GetQueueCommand Input
See GetQueueCommandInput for more details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
Name Required | string | undefined | The name of the queue that you want information about. |
GetQueueCommand Output
See GetQueueCommandOutput for details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
Queue | Queue | undefined | You can use queues to manage the resources that are available to your AWS account for running multiple transcoding jobs at the same time. If you don't specify a queue, the service sends all jobs through the default queue. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
BadRequestException | client | The service can't process your request because of a problem in the request. Please check your request form and syntax. |
ConflictException | client | The service couldn't complete your request because there is a conflict with the current state of the resource. |
ForbiddenException | client | You don't have permissions for this action with the credentials you sent. |
InternalServerErrorException | server | The service encountered an unexpected condition and can't fulfill your request. |
NotFoundException | client | The resource you requested doesn't exist. |
TooManyRequestsException | client | Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests. |
MediaConvertServiceException | Base exception class for all service exceptions from MediaConvert service. |