Module Values.GetQueueResponseSource

Mixin that adds an optional ARN field to response structures. Apply to SummaryMixins (flows into Get, Summary, and BatchGet) and Create outputs.

Sourcetype nonrec t = {
  1. farmId : FarmId.t option;
    (*

    The farm ID for the queue.

    *)
  2. queueId : QueueId.t option;
    (*

    The queue ID.

    *)
  3. displayName : ResourceName.t option;
    (*

    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.

    *)
  4. status : QueueStatus.t option;
    (*

    The status of the queue. ACTIVE–The queue is active. SCHEDULING–The queue is scheduling. SCHEDULING_BLOCKED–The queue scheduling is blocked. See the provided reason.

    *)
  5. defaultBudgetAction : DefaultQueueBudgetAction.t option;
    (*

    The default action taken on a queue if a budget wasn't configured.

    *)
  6. blockedReason : QueueBlockedReason.t option;
    (*

    The reason the queue was blocked.

    *)
  7. createdAt : CreatedAt.t option;
    (*

    The date and time the resource was created.

    *)
  8. createdBy : CreatedBy.t option;
    (*

    The user or system that created this resource.

    *)
  9. updatedAt : UpdatedAt.t option;
    (*

    The date and time the resource was updated.

    *)
  10. updatedBy : UpdatedBy.t option;
    (*

    The user or system that updated this resource.

    *)
  11. description : Description.t option;
    (*

    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.

    *)
  12. jobAttachmentSettings : JobAttachmentSettings.t option;
    (*

    The job attachment settings for the queue.

    *)
  13. roleArn : IamRoleArn.t option;
    (*

    The IAM role ARN.

    *)
  14. requiredFileSystemLocationNames : RequiredFileSystemLocationNames.t option;
    (*

    A list of the required file system location names in the queue.

    *)
  15. allowedStorageProfileIds : AllowedStorageProfileIds.t option;
    (*

    The storage profile IDs for the queue.

    *)
  16. jobRunAsUser : JobRunAsUser.t option;
    (*

    The jobs in the queue ran as this specified POSIX user.

    *)
  17. schedulingConfiguration : SchedulingConfiguration.t option;
    (*

    The scheduling configuration for the queue. This configuration determines how workers are assigned to jobs in the queue.

    *)
}
Sourcetype nonrec error = [
  1. | `AccessDeniedException of AccessDeniedException.t
  2. | `InternalServerErrorException of InternalServerErrorException.t
  3. | `ResourceNotFoundException of ResourceNotFoundException.t
  4. | `ThrottlingException of ThrottlingException.t
  5. | `ValidationException of ValidationException.t
  6. | `Unknown_operation_error of string * string option
]
Sourceval make : ?farmId:??? -> ?queueId:??? -> ?displayName:??? -> ?status:??? -> ?defaultBudgetAction:??? -> ?blockedReason:??? -> ?createdAt:??? -> ?createdBy:??? -> ?updatedAt:??? -> ?updatedBy:??? -> ?description:??? -> ?jobAttachmentSettings:??? -> ?roleArn:??? -> ?requiredFileSystemLocationNames:??? -> ?allowedStorageProfileIds:??? -> ?jobRunAsUser:??? -> ?schedulingConfiguration:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `AccessDeniedException of AccessDeniedException.t | `InternalServerErrorException of InternalServerErrorException.t | `ResourceNotFoundException of ResourceNotFoundException.t | `ThrottlingException of ThrottlingException.t | `Unknown_operation_error of string * string option | `ValidationException of ValidationException.t ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `AccessDeniedException of AccessDeniedException.t | `InternalServerErrorException of InternalServerErrorException.t | `ResourceNotFoundException of ResourceNotFoundException.t | `ThrottlingException of ThrottlingException.t | `Unknown_operation_error of string * string option | `ValidationException of ValidationException.t ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `List of [> `String of FileSystemLocationName.t ] list | `String of FarmId.t | `Structure of (string * [> `Enum of string | `String of S3BucketName.t | `Structure of (string * [> `Double of SchedulingPriorityWeight.t | `Integer of SchedulingRenderingTaskBuffer.t | `String of PosixUserUserString.t | `Structure of (string * [> `Structure of 'a list ]) list ]) list ]) list | `Timestamp of CreatedAt.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t