Deadline class
The Amazon Web Services Deadline Cloud API provides infrastructure and centralized management for your projects. Use the Deadline Cloud API to onboard users, assign projects, and attach permissions specific to their job function.
With Deadline Cloud, content production teams can deploy resources for their workforce securely in the cloud, reducing the costs of added physical infrastructure. Keep your content production operations secure, while allowing your contributors to access the tools they need, such as scalable high-speed storage, licenses, and cost management services.
Constructors
- Deadline({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
associateMemberToFarm(
{required String farmId, required String identityStoreId, required MembershipLevel membershipLevel, required String principalId, required DeadlinePrincipalType principalType}) → Future< void> - Assigns a farm membership level to a member.
-
associateMemberToFleet(
{required String farmId, required String fleetId, required String identityStoreId, required MembershipLevel membershipLevel, required String principalId, required DeadlinePrincipalType principalType}) → Future< void> - Assigns a fleet membership level to a member.
-
associateMemberToJob(
{required String farmId, required String identityStoreId, required String jobId, required MembershipLevel membershipLevel, required String principalId, required DeadlinePrincipalType principalType, required String queueId}) → Future< void> - Assigns a job membership level to a member
-
associateMemberToQueue(
{required String farmId, required String identityStoreId, required MembershipLevel membershipLevel, required String principalId, required DeadlinePrincipalType principalType, required String queueId}) → Future< void> - Assigns a queue membership level to a member
-
assumeFleetRoleForRead(
{required String farmId, required String fleetId}) → Future< AssumeFleetRoleForReadResponse> - Get Amazon Web Services credentials from the fleet role. The IAM permissions of the credentials are scoped down to have read-only access.
-
assumeFleetRoleForWorker(
{required String farmId, required String fleetId, required String workerId}) → Future< AssumeFleetRoleForWorkerResponse> - Get credentials from the fleet role for a worker.
-
assumeQueueRoleForRead(
{required String farmId, required String queueId}) → Future< AssumeQueueRoleForReadResponse> - Gets Amazon Web Services credentials from the queue role. The IAM permissions of the credentials are scoped down to have read-only access.
-
assumeQueueRoleForUser(
{required String farmId, required String queueId}) → Future< AssumeQueueRoleForUserResponse> - Allows a user to assume a role for a queue.
-
assumeQueueRoleForWorker(
{required String farmId, required String fleetId, required String queueId, required String workerId}) → Future< AssumeQueueRoleForWorkerResponse> - Allows a worker to assume a queue role.
-
batchGetJob(
{required List< BatchGetJobIdentifier> identifiers}) → Future<BatchGetJobResponse> -
Retrieves multiple jobs in a single request. This is a batch version of
the
GetJobAPI. -
batchGetJobEntity(
{required String farmId, required String fleetId, required List< JobEntityIdentifiersUnion> identifiers, required String workerId}) → Future<BatchGetJobEntityResponse> - Get batched job details for a worker.
-
batchGetSession(
{required List< BatchGetSessionIdentifier> identifiers}) → Future<BatchGetSessionResponse> -
Retrieves multiple sessions in a single request. This is a batch version
of the
GetSessionAPI. -
batchGetSessionAction(
{required List< BatchGetSessionActionIdentifier> identifiers}) → Future<BatchGetSessionActionResponse> -
Retrieves multiple session actions in a single request. This is a batch
version of the
GetSessionActionAPI. -
batchGetStep(
{required List< BatchGetStepIdentifier> identifiers}) → Future<BatchGetStepResponse> -
Retrieves multiple steps in a single request. This is a batch version of
the
GetStepAPI. -
batchGetTask(
{required List< BatchGetTaskIdentifier> identifiers}) → Future<BatchGetTaskResponse> -
Retrieves multiple tasks in a single request. This is a batch version of
the
GetTaskAPI. -
batchGetWorker(
{required List< BatchGetWorkerIdentifier> identifiers}) → Future<BatchGetWorkerResponse> -
Retrieves multiple workers in a single request. This is a batch version of
the
GetWorkerAPI. -
batchUpdateJob(
{required List< BatchUpdateJobItem> jobs, String? clientToken}) → Future<BatchUpdateJobResponse> -
Updates multiple jobs in a single request. This is a batch version of the
UpdateJobAPI. -
batchUpdateTask(
{required List< BatchUpdateTaskItem> tasks, String? clientToken}) → Future<BatchUpdateTaskResponse> -
Updates multiple tasks in a single request. This is a batch version of the
UpdateTaskAPI. -
close(
) → void - Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
-
copyJobTemplate(
{required String farmId, required String jobId, required String queueId, required S3Location targetS3Location}) → Future< CopyJobTemplateResponse> - Copies a job template to an Amazon S3 bucket.
-
createBudget(
{required List< BudgetActionToAdd> actions, required double approximateDollarLimit, required String displayName, required String farmId, required BudgetSchedule schedule, required UsageTrackingResource usageTrackingResource, String? clientToken, String? description, Map<String, String> ? tags}) → Future<CreateBudgetResponse> - Creates a budget to set spending thresholds for your rendering activity.
-
createFarm(
{required String displayName, String? clientToken, double? costScaleFactor, String? description, String? kmsKeyArn, Map< String, String> ? tags}) → Future<CreateFarmResponse> - Creates a farm to allow space for queues and fleets. Farms are the space where the components of your renders gather and are pieced together in the cloud. Farms contain budgets and allow you to enforce permissions. Deadline Cloud farms are a useful container for large projects.
-
createFleet(
{required FleetConfiguration configuration, required String displayName, required String farmId, required int maxWorkerCount, required String roleArn, String? clientToken, String? description, HostConfiguration? hostConfiguration, int? minWorkerCount, Map< String, String> ? tags}) → Future<CreateFleetResponse> - Creates a fleet. Fleets gather information relating to compute, or capacity, for renders within your farms. You can choose to manage your own capacity or opt to have fleets fully managed by Deadline Cloud.
-
createJob(
{required String farmId, required int priority, required String queueId, Attachments? attachments, String? clientToken, String? descriptionOverride, int? maxFailedTasksCount, int? maxRetriesPerTask, int? maxWorkerCount, String? nameOverride, Map< String, JobParameter> ? parameters, String? sourceJobId, String? storageProfileId, Map<String, String> ? tags, CreateJobTargetTaskRunStatus? targetTaskRunStatus, String? template, JobTemplateType? templateType}) → Future<CreateJobResponse> - Creates a job. A job is a set of instructions that Deadline Cloud uses to schedule and run work on available workers. For more information, see Deadline Cloud jobs.
-
createLicenseEndpoint(
{required List< String> securityGroupIds, required List<String> subnetIds, required String vpcId, String? clientToken, Map<String, String> ? tags}) → Future<CreateLicenseEndpointResponse> - Creates a license endpoint to integrate your various licensed software used for rendering on Deadline Cloud.
-
createLimit(
{required String amountRequirementName, required String displayName, required String farmId, required int maxCount, String? clientToken, String? description}) → Future< CreateLimitResponse> - Creates a limit that manages the distribution of shared resources, such as floating licenses. A limit can throttle work assignments, help manage workloads, and track current usage. Before you use a limit, you must associate the limit with one or more queues.
-
createMonitor(
{required String displayName, required String identityCenterInstanceArn, required String roleArn, required String subdomain, String? clientToken, String? identityCenterRegion, Map< String, String> ? tags}) → Future<CreateMonitorResponse> - Creates an Amazon Web Services Deadline Cloud monitor that you can use to view your farms, queues, and fleets. After you submit a job, you can track the progress of the tasks and steps that make up the job, and then download the job's results.
-
createQueue(
{required String displayName, required String farmId, List< String> ? allowedStorageProfileIds, String? clientToken, DefaultQueueBudgetAction? defaultBudgetAction, String? description, JobAttachmentSettings? jobAttachmentSettings, JobRunAsUser? jobRunAsUser, List<String> ? requiredFileSystemLocationNames, String? roleArn, SchedulingConfiguration? schedulingConfiguration, Map<String, String> ? tags}) → Future<CreateQueueResponse> - 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.
-
createQueueEnvironment(
{required String farmId, required int priority, required String queueId, required String template, required EnvironmentTemplateType templateType, String? clientToken}) → Future< CreateQueueEnvironmentResponse> - Creates an environment for a queue that defines how jobs in the queue run.
-
createQueueFleetAssociation(
{required String farmId, required String fleetId, required String queueId}) → Future< void> - Creates an association between a queue and a fleet.
-
createQueueLimitAssociation(
{required String farmId, required String limitId, required String queueId}) → Future< void> -
Associates a limit with a particular queue. After the limit is associated,
all workers for jobs that specify the limit associated with the queue are
subject to the limit. You can't associate two limits with the same
amountRequirementNameto the same queue. -
createStorageProfile(
{required String displayName, required String farmId, required StorageProfileOperatingSystemFamily osFamily, String? clientToken, List< FileSystemLocation> ? fileSystemLocations}) → Future<CreateStorageProfileResponse> - Creates a storage profile that specifies the operating system, file type, and file location of resources used on a farm.
-
createWorker(
{required String farmId, required String fleetId, String? clientToken, HostPropertiesRequest? hostProperties, Map< String, String> ? tags}) → Future<CreateWorkerResponse> - Creates a worker. A worker tells your instance how much processing power (vCPU), and memory (GiB) you’ll need to assemble the digital assets held within a particular instance. You can specify certain instance types to use, or let the worker know which instances types to exclude.
-
deleteBudget(
{required String budgetId, required String farmId}) → Future< void> - Deletes a budget.
-
deleteFarm(
{required String farmId}) → Future< void> - Deletes a farm.
-
deleteFleet(
{required String farmId, required String fleetId, String? clientToken}) → Future< void> - Deletes a fleet.
-
deleteLicenseEndpoint(
{required String licenseEndpointId}) → Future< void> - Deletes a license endpoint.
-
deleteLimit(
{required String farmId, required String limitId}) → Future< void> -
Removes a limit from the specified farm. Before you delete a limit you
must use the
DeleteQueueLimitAssociationoperation to remove the association with any queues. -
deleteMeteredProduct(
{required String licenseEndpointId, required String productId}) → Future< void> - Deletes a metered product.
-
deleteMonitor(
{required String monitorId}) → Future< void> - Removes a Deadline Cloud monitor. After you delete a monitor, you can create a new one and attach farms to the monitor.
-
deleteQueue(
{required String farmId, required String queueId}) → Future< void> - Deletes a queue.
-
deleteQueueEnvironment(
{required String farmId, required String queueEnvironmentId, required String queueId}) → Future< void> - Deletes a queue environment.
-
deleteQueueFleetAssociation(
{required String farmId, required String fleetId, required String queueId}) → Future< void> - Deletes a queue-fleet association.
-
deleteQueueLimitAssociation(
{required String farmId, required String limitId, required String queueId}) → Future< void> -
Removes the association between a queue and a limit. You must use the
UpdateQueueLimitAssociationoperation to set the status toSTOP_LIMIT_USAGE_AND_COMPLETE_TASKSorSTOP_LIMIT_USAGE_AND_CANCEL_TASKS. The status does not change immediately. Use theGetQueueLimitAssociationoperation to see if the status changed toSTOPPEDbefore deleting the association. -
deleteStorageProfile(
{required String farmId, required String storageProfileId}) → Future< void> - Deletes a storage profile.
-
deleteVolume(
{required String farmId, required String fleetId, required String volumeId}) → Future< void> - Deletes a persistent volume.
-
deleteWorker(
{required String farmId, required String fleetId, required String workerId}) → Future< void> - Deletes a worker.
-
disassociateMemberFromFarm(
{required String farmId, required String principalId}) → Future< void> - Disassociates a member from a farm.
-
disassociateMemberFromFleet(
{required String farmId, required String fleetId, required String principalId}) → Future< void> - Disassociates a member from a fleet.
-
disassociateMemberFromJob(
{required String farmId, required String jobId, required String principalId, required String queueId}) → Future< void> - Disassociates a member from a job.
-
disassociateMemberFromQueue(
{required String farmId, required String principalId, required String queueId}) → Future< void> - Disassociates a member from a queue.
-
getBudget(
{required String budgetId, required String farmId}) → Future< GetBudgetResponse> - Get a budget.
-
getFarm(
{required String farmId}) → Future< GetFarmResponse> - Get a farm.
-
getFleet(
{required String farmId, required String fleetId}) → Future< GetFleetResponse> - Get a fleet.
-
getJob(
{required String farmId, required String jobId, required String queueId}) → Future< GetJobResponse> - Gets a Deadline Cloud job.
-
getLicenseEndpoint(
{required String licenseEndpointId}) → Future< GetLicenseEndpointResponse> - Gets a licence endpoint.
-
getLimit(
{required String farmId, required String limitId}) → Future< GetLimitResponse> - Gets information about a specific limit.
-
getMonitor(
{required String monitorId}) → Future< GetMonitorResponse> - Gets information about the specified monitor.
-
getMonitorSettings(
{required String monitorId}) → Future< GetMonitorSettingsResponse> - Gets the settings for a Deadline Cloud monitor.
-
getQueue(
{required String farmId, required String queueId}) → Future< GetQueueResponse> - Gets a queue.
-
getQueueEnvironment(
{required String farmId, required String queueEnvironmentId, required String queueId}) → Future< GetQueueEnvironmentResponse> - Gets a queue environment.
-
getQueueFleetAssociation(
{required String farmId, required String fleetId, required String queueId}) → Future< GetQueueFleetAssociationResponse> - Gets a queue-fleet association.
-
getQueueLimitAssociation(
{required String farmId, required String limitId, required String queueId}) → Future< GetQueueLimitAssociationResponse> - Gets information about a specific association between a queue and a limit.
-
getSession(
{required String farmId, required String jobId, required String queueId, required String sessionId}) → Future< GetSessionResponse> - Gets a session.
-
getSessionAction(
{required String farmId, required String jobId, required String queueId, required String sessionActionId}) → Future< GetSessionActionResponse> - Gets a session action for the job.
-
getSessionsStatisticsAggregation(
{required String aggregationId, required String farmId, int? maxResults, String? nextToken}) → Future< GetSessionsStatisticsAggregationResponse> -
Gets a set of statistics for queues or farms. Before you can call the
GetSessionStatisticsAggregationoperation, you must first call theStartSessionsStatisticsAggregationoperation. Statistics are available for 1 hour after you call theStartSessionsStatisticsAggregationoperation. -
getStep(
{required String farmId, required String jobId, required String queueId, required String stepId}) → Future< GetStepResponse> - Gets a step.
-
getStorageProfile(
{required String farmId, required String storageProfileId}) → Future< GetStorageProfileResponse> - Gets a storage profile.
-
getStorageProfileForQueue(
{required String farmId, required String queueId, required String storageProfileId}) → Future< GetStorageProfileForQueueResponse> - Gets a storage profile for a queue.
-
getTask(
{required String farmId, required String jobId, required String queueId, required String stepId, required String taskId}) → Future< GetTaskResponse> - Gets a task.
-
getVolume(
{required String farmId, required String fleetId, required String volumeId}) → Future< GetVolumeResponse> - Gets a persistent volume.
-
getWorker(
{required String farmId, required String fleetId, required String workerId}) → Future< GetWorkerResponse> - Gets a worker.
-
listAvailableMeteredProducts(
{int? maxResults, String? nextToken}) → Future< ListAvailableMeteredProductsResponse> - A list of the available metered products.
-
listBudgets(
{required String farmId, int? maxResults, String? nextToken, BudgetStatus? status}) → Future< ListBudgetsResponse> - A list of budgets in a farm.
-
listFarmMembers(
{required String farmId, int? maxResults, String? nextToken}) → Future< ListFarmMembersResponse> - Lists the members of a farm.
-
listFarms(
{int? maxResults, String? nextToken, String? principalId}) → Future< ListFarmsResponse> - Lists farms.
-
listFleetMembers(
{required String farmId, required String fleetId, int? maxResults, String? nextToken}) → Future< ListFleetMembersResponse> - Lists fleet members.
-
listFleets(
{required String farmId, String? displayName, int? maxResults, String? nextToken, String? principalId, FleetStatus? status}) → Future< ListFleetsResponse> - Lists fleets.
-
listJobMembers(
{required String farmId, required String jobId, required String queueId, int? maxResults, String? nextToken}) → Future< ListJobMembersResponse> - Lists members on a job.
-
listJobParameterDefinitions(
{required String farmId, required String jobId, required String queueId, int? maxResults, String? nextToken}) → Future< ListJobParameterDefinitionsResponse> - Lists parameter definitions of a job.
-
listJobs(
{required String farmId, required String queueId, int? maxResults, String? nextToken, String? principalId}) → Future< ListJobsResponse> - Lists jobs.
-
listLicenseEndpoints(
{int? maxResults, String? nextToken}) → Future< ListLicenseEndpointsResponse> - Lists license endpoints.
-
listLimits(
{required String farmId, int? maxResults, String? nextToken}) → Future< ListLimitsResponse> - Gets a list of limits defined in the specified farm.
-
listMeteredProducts(
{required String licenseEndpointId, int? maxResults, String? nextToken}) → Future< ListMeteredProductsResponse> - Lists metered products.
-
listMonitors(
{int? maxResults, String? nextToken}) → Future< ListMonitorsResponse> - Gets a list of your monitors in Deadline Cloud.
-
listQueueEnvironments(
{required String farmId, required String queueId, int? maxResults, String? nextToken}) → Future< ListQueueEnvironmentsResponse> - Lists queue environments.
-
listQueueFleetAssociations(
{required String farmId, String? fleetId, int? maxResults, String? nextToken, String? queueId}) → Future< ListQueueFleetAssociationsResponse> - Lists queue-fleet associations.
-
listQueueLimitAssociations(
{required String farmId, String? limitId, int? maxResults, String? nextToken, String? queueId}) → Future< ListQueueLimitAssociationsResponse> - Gets a list of the associations between queues and limits defined in a farm.
-
listQueueMembers(
{required String farmId, required String queueId, int? maxResults, String? nextToken}) → Future< ListQueueMembersResponse> - Lists the members in a queue.
-
listQueues(
{required String farmId, int? maxResults, String? nextToken, String? principalId, QueueStatus? status}) → Future< ListQueuesResponse> - Lists queues.
-
listSessionActions(
{required String farmId, required String jobId, required String queueId, int? maxResults, String? nextToken, String? sessionId, String? taskId}) → Future< ListSessionActionsResponse> - Lists session actions.
-
listSessions(
{required String farmId, required String jobId, required String queueId, int? maxResults, String? nextToken}) → Future< ListSessionsResponse> - Lists sessions.
-
listSessionsForWorker(
{required String farmId, required String fleetId, required String workerId, int? maxResults, String? nextToken}) → Future< ListSessionsForWorkerResponse> - Lists sessions for a worker.
-
listStepConsumers(
{required String farmId, required String jobId, required String queueId, required String stepId, int? maxResults, String? nextToken}) → Future< ListStepConsumersResponse> - Lists step consumers.
-
listStepDependencies(
{required String farmId, required String jobId, required String queueId, required String stepId, int? maxResults, String? nextToken}) → Future< ListStepDependenciesResponse> - Lists the dependencies for a step.
-
listSteps(
{required String farmId, required String jobId, required String queueId, int? maxResults, String? nextToken}) → Future< ListStepsResponse> - Lists steps for a job.
-
listStorageProfiles(
{required String farmId, int? maxResults, String? nextToken}) → Future< ListStorageProfilesResponse> - Lists storage profiles.
-
listStorageProfilesForQueue(
{required String farmId, required String queueId, int? maxResults, String? nextToken}) → Future< ListStorageProfilesForQueueResponse> - Lists storage profiles for a queue.
-
listTagsForResource(
{required String resourceArn}) → Future< ListTagsForResourceResponse> - Lists tags for a resource.
-
listTasks(
{required String farmId, required String jobId, required String queueId, required String stepId, int? maxResults, String? nextToken}) → Future< ListTasksResponse> - Lists tasks for a job.
-
listVolumes(
{required String farmId, required String fleetId, int? maxResults, String? nextToken}) → Future< ListVolumesResponse> - Lists the persistent volumes in a fleet.
-
listWorkers(
{required String farmId, required String fleetId, int? maxResults, String? nextToken}) → Future< ListWorkersResponse> - Lists workers.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
putMeteredProduct(
{required String licenseEndpointId, required String productId}) → Future< void> - Adds a metered product.
-
searchJobs(
{required String farmId, required int itemOffset, required List< String> queueIds, SearchGroupedFilterExpressions? filterExpressions, int? pageSize, List<SearchSortExpression> ? sortExpressions}) → Future<SearchJobsResponse> - Searches for jobs.
-
searchSteps(
{required String farmId, required int itemOffset, required List< String> queueIds, SearchGroupedFilterExpressions? filterExpressions, String? jobId, int? pageSize, List<SearchSortExpression> ? sortExpressions}) → Future<SearchStepsResponse> - Searches for steps.
-
searchTasks(
{required String farmId, required int itemOffset, required List< String> queueIds, SearchGroupedFilterExpressions? filterExpressions, String? jobId, int? pageSize, List<SearchSortExpression> ? sortExpressions}) → Future<SearchTasksResponse> - Searches for tasks.
-
searchWorkers(
{required String farmId, required List< String> fleetIds, required int itemOffset, SearchGroupedFilterExpressions? filterExpressions, int? pageSize, List<SearchSortExpression> ? sortExpressions}) → Future<SearchWorkersResponse> - Searches for workers.
-
startSessionsStatisticsAggregation(
{required DateTime endTime, required String farmId, required List< UsageGroupByField> groupBy, required SessionsStatisticsResources resourceIds, required DateTime startTime, required List<UsageStatistic> statistics, Period? period, String? timezone}) → Future<StartSessionsStatisticsAggregationResponse> -
Starts an asynchronous request for getting aggregated statistics about
queues and farms. Get the statistics using the
GetSessionsStatisticsAggregationoperation. You can only have one running aggregation for your Deadline Cloud farm. Call theGetSessionsStatisticsAggregationoperation and check thestatusfield to see if an aggregation is running. Statistics are available for 1 hour after you call theStartSessionsStatisticsAggregationoperation. -
tagResource(
{required String resourceArn, Map< String, String> ? tags}) → Future<void> - Tags a resource using the resource's ARN and desired tags.
-
toString(
) → String -
A string representation of this object.
inherited
-
untagResource(
{required String resourceArn, required List< String> tagKeys}) → Future<void> - Removes a tag from a resource using the resource's ARN and tag to remove.
-
updateBudget(
{required String budgetId, required String farmId, List< BudgetActionToAdd> ? actionsToAdd, List<BudgetActionToRemove> ? actionsToRemove, double? approximateDollarLimit, String? clientToken, String? description, String? displayName, BudgetSchedule? schedule, BudgetStatus? status}) → Future<void> - Updates a budget that sets spending thresholds for rendering activity.
-
updateFarm(
{required String farmId, double? costScaleFactor, String? description, String? displayName}) → Future< void> - Updates a farm.
-
updateFleet(
{required String farmId, required String fleetId, String? clientToken, FleetConfiguration? configuration, String? description, String? displayName, HostConfiguration? hostConfiguration, int? maxWorkerCount, int? minWorkerCount, String? roleArn}) → Future< void> - Updates a fleet.
-
updateJob(
{required String farmId, required String jobId, required String queueId, String? clientToken, String? description, UpdateJobLifecycleStatus? lifecycleStatus, int? maxFailedTasksCount, int? maxRetriesPerTask, int? maxWorkerCount, String? name, int? priority, JobTargetTaskRunStatus? targetTaskRunStatus}) → Future< void> - Updates a job.
-
updateLimit(
{required String farmId, required String limitId, String? description, String? displayName, int? maxCount}) → Future< void> - Updates the properties of the specified limit.
-
updateMonitor(
{required String monitorId, String? displayName, String? roleArn, String? subdomain}) → Future< void> -
Modifies the settings for a Deadline Cloud monitor. You can modify one or
all of the settings when you call
UpdateMonitor. -
updateMonitorSettings(
{required String monitorId, required Map< String, String> settings}) → Future<void> - Updates the settings for a Deadline Cloud monitor. Keys present in the request are upserted; keys absent are left unchanged. Send an empty string value to delete a key.
-
updateQueue(
{required String farmId, required String queueId, List< String> ? allowedStorageProfileIdsToAdd, List<String> ? allowedStorageProfileIdsToRemove, String? clientToken, DefaultQueueBudgetAction? defaultBudgetAction, String? description, String? displayName, JobAttachmentSettings? jobAttachmentSettings, JobRunAsUser? jobRunAsUser, List<String> ? requiredFileSystemLocationNamesToAdd, List<String> ? requiredFileSystemLocationNamesToRemove, String? roleArn, SchedulingConfiguration? schedulingConfiguration}) → Future<void> - Updates a queue.
-
updateQueueEnvironment(
{required String farmId, required String queueEnvironmentId, required String queueId, String? clientToken, int? priority, String? template, EnvironmentTemplateType? templateType}) → Future< void> - Updates the queue environment.
-
updateQueueFleetAssociation(
{required String farmId, required String fleetId, required String queueId, required UpdateQueueFleetAssociationStatus status}) → Future< void> - Updates a queue-fleet association.
-
updateQueueLimitAssociation(
{required String farmId, required String limitId, required String queueId, required UpdateQueueLimitAssociationStatus status}) → Future< void> -
Updates the status of the queue. If you set the status to one of the
STOP_LIMIT_USAGE*values, there will be a delay before the status transitions to theSTOPPEDstate. -
updateSession(
{required String farmId, required String jobId, required String queueId, required String sessionId, required SessionLifecycleTargetStatus targetLifecycleStatus, String? clientToken}) → Future< void> - Updates a session.
-
updateStep(
{required String farmId, required String jobId, required String queueId, required String stepId, required StepTargetTaskRunStatus targetTaskRunStatus, String? clientToken}) → Future< void> - Updates a step.
-
updateStorageProfile(
{required String farmId, required String storageProfileId, String? clientToken, String? displayName, List< FileSystemLocation> ? fileSystemLocationsToAdd, List<FileSystemLocation> ? fileSystemLocationsToRemove, StorageProfileOperatingSystemFamily? osFamily}) → Future<void> - Updates a storage profile.
-
updateTask(
{required String farmId, required String jobId, required String queueId, required String stepId, required TaskTargetRunStatus targetRunStatus, required String taskId, String? clientToken}) → Future< void> - Updates a task.
-
updateWorker(
{required String farmId, required String fleetId, required String workerId, WorkerCapabilities? capabilities, HostPropertiesRequest? hostProperties, UpdatedWorkerStatus? status}) → Future< UpdateWorkerResponse> - Updates a worker.
-
updateWorkerSchedule(
{required String farmId, required String fleetId, required String workerId, Map< String, UpdatedSessionActionInfo> ? updatedSessionActions}) → Future<UpdateWorkerScheduleResponse> - Updates the schedule for a worker.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited