AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the AWSDeadlineCloud CreateQueue API operation.

Syntax

New-ADCQueue
-AllowedStorageProfileId <String[]>
-SchedulingConfiguration_WeightedBalanced_MaxPriorityOverride_AlwaysScheduleFirst <SchedulingMaxPriorityOverrideAlwaysScheduleFirst>
-SchedulingConfiguration_WeightedBalanced_MinPriorityOverride_AlwaysScheduleLast <SchedulingMinPriorityOverrideAlwaysScheduleLast>
-DefaultBudgetAction <DefaultQueueBudgetAction>
-Description <String>
-DisplayName <String>
-SchedulingConfiguration_WeightedBalanced_ErrorWeight <Double>
-FarmId <String>
-Posix_Group <String>
-Windows_PasswordArn <String>
-SchedulingConfiguration_PriorityFifo <PriorityFifoSchedulingConfiguration>
-SchedulingConfiguration_WeightedBalanced_PriorityWeight <Double>
-SchedulingConfiguration_PriorityBalanced_RenderingTaskBuffer <Int32>
-SchedulingConfiguration_WeightedBalanced_RenderingTaskBuffer <Int32>
-SchedulingConfiguration_WeightedBalanced_RenderingTaskWeight <Double>
-RequiredFileSystemLocationName <String[]>
-RoleArn <String>
-JobAttachmentSettings_RootPrefix <String>
-JobRunAsUser_RunAs <RunAs>
-JobAttachmentSettings_S3BucketName <String>
-SchedulingConfiguration_WeightedBalanced_SubmissionTimeWeight <Double>
-Tag <Hashtable>
-Posix_User <String>
-Windows_User <String>
-ClientToken <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonDeadlineConfig>

Description

Creates a queue to coordinate the order in which jobs run on a farm. A queue can also specify where to pull resources and indicate where to output completed jobs.

Parameters

-AllowedStorageProfileId <String[]>
The storage profile IDs to include in the queue. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAllowedStorageProfileIds
-ClientConfig <AmazonDeadlineConfig>
Amazon.PowerShell.Cmdlets.ADC.AmazonDeadlineClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
The unique token which the server uses to recognize retries of the same request.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DefaultBudgetAction <DefaultQueueBudgetAction>
The default action to take on a queue if a budget isn't configured.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Description <String>
The description of the queue.This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DisplayName <String>
The display name of the queue.This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-FarmId <String>
The farm ID of the farm to connect to the queue.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-JobAttachmentSettings_RootPrefix <String>
The root prefix.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-JobAttachmentSettings_S3BucketName <String>
The Amazon S3 bucket name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-JobRunAsUser_RunAs <RunAs>
Specifies whether the job should run using the queue's system user or if the job should run using the worker agent system user.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Posix_Group <String>
The name of the POSIX user's group.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesJobRunAsUser_Posix_Group
-Posix_User <String>
The name of the POSIX user.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesJobRunAsUser_Posix_User
-RequiredFileSystemLocationName <String[]>
The file system location name to include in the queue. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRequiredFileSystemLocationNames
-RoleArn <String>
The IAM role ARN that workers will use while running jobs for this queue.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SchedulingConfiguration_PriorityBalanced_RenderingTaskBuffer <Int32>
The rendering task buffer controls worker stickiness. A worker only switches from its current job to another job at the same priority if the other job has fewer rendering tasks by more than this buffer value. Higher values make workers stickier to their current jobs. The default value is 1.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SchedulingConfiguration_PriorityFifo <PriorityFifoSchedulingConfiguration>
Workers are assigned to the highest-priority job first. When multiple jobs share the same priority, the job submitted earliest receives workers first. This is the default scheduling configuration for new queues.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SchedulingConfiguration_WeightedBalanced_ErrorWeight <Double>
The weight applied to the number of errors on a job. A negative value means jobs without errors are scheduled first. A value of 0 means errors are ignored. The default value is -10.0.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SchedulingConfiguration_WeightedBalanced_MaxPriorityOverride_AlwaysScheduleFirst <SchedulingMaxPriorityOverrideAlwaysScheduleFirst>
Jobs at the maximum priority (100) are always scheduled before other jobs, regardless of the weighted scheduling formula. If multiple jobs have priority 100, ties are broken using the standard weighted formula.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SchedulingConfiguration_WeightedBalanced_MinPriorityOverride_AlwaysScheduleLast <SchedulingMinPriorityOverrideAlwaysScheduleLast>
Jobs at the minimum priority (0) are always scheduled after all other jobs, regardless of the weighted scheduling formula. If multiple jobs have priority 0, ties are broken using the standard weighted formula.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SchedulingConfiguration_WeightedBalanced_PriorityWeight <Double>
The weight applied to job priority in the scheduling formula. Higher values give more influence to job priority. A value of 0 means priority is ignored. The default value is 100.0.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SchedulingConfiguration_WeightedBalanced_RenderingTaskBuffer <Int32>
The rendering task buffer is subtracted from the number of rendering tasks before applying the rendering task weight. This creates a stickiness effect where workers prefer to stay with their current job. Higher values make workers stickier. The default value is 1. The buffer is only applied in the weight calculation for a job if the worker is currently assigned to that job.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SchedulingConfiguration_WeightedBalanced_RenderingTaskWeight <Double>
The weight applied to the number of tasks currently rendering on a job. A negative value means jobs that are not already rendering are scheduled next. A value of 0 means the rendering state is ignored. The default value is -100.0.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SchedulingConfiguration_WeightedBalanced_SubmissionTimeWeight <Double>
The weight applied to job submission time. A positive value means earlier jobs are scheduled first. A value of 0 means submission time is ignored. The default value is 3.0.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'QueueId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Deadline.Model.CreateQueueResponse). Specifying the name of a property of type Amazon.Deadline.Model.CreateQueueResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Hashtable>
Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-Windows_PasswordArn <String>
The password ARN for the Windows user.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesJobRunAsUser_Windows_PasswordArn
-Windows_User <String>
The user.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesJobRunAsUser_Windows_User

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

System.String or Amazon.Deadline.Model.CreateQueueResponse
This cmdlet returns a System.String object. The service call response (type Amazon.Deadline.Model.CreateQueueResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z