types

package
v1.21.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 8, 2025 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AcceleratorCapabilities added in v1.7.0 

type AcceleratorCapabilities struct {

	// A list of accelerator capabilities requested for this fleet. Only Amazon
	// Elastic Compute Cloud instances that provide these capabilities will be used.
	// For example, if you specify both L4 and T4 chips, Deadline Cloud will use Amazon
	// EC2 instances that have either the L4 or the T4 chip installed.
	//
	// This member is required.
	Selections []AcceleratorSelection

	// The number of GPU accelerators specified for worker hosts in this fleet.
	Count *AcceleratorCountRange
	// contains filtered or unexported fields
}

Provides information about the GPU accelerators used for jobs processed by a fleet.

type AcceleratorCountRange 

type AcceleratorCountRange struct {

	// The minimum number of GPU accelerators in the worker host.
	//
	// This member is required.
	Min *int32

	// The maximum number of GPU accelerators in the worker host.
	Max *int32
	// contains filtered or unexported fields
}

Defines the maximum and minimum number of GPU accelerators required for a worker instance..

type AcceleratorName added in v1.7.0 

type AcceleratorName string
const (
	AcceleratorNameT4   AcceleratorName = "t4"
	AcceleratorNameA10g AcceleratorName = "a10g"
	AcceleratorNameL4   AcceleratorName = "l4"
	AcceleratorNameL40s AcceleratorName = "l40s"
)

Enum values for AcceleratorName

func (AcceleratorName) Values added in v1.7.0 

func (AcceleratorName) Values() []AcceleratorName

Values returns all known values for AcceleratorName. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AcceleratorSelection added in v1.7.0 

type AcceleratorSelection struct {

	// The name of the chip used by the GPU accelerator.
	//
	// If you specify l4 as the name of the accelerator, you must specify latest or
	// grid:r570 as the runtime.
	//
	// The available GPU accelerators are:
	//
	//   - t4 - NVIDIA T4 Tensor Core GPU
	//
	//   - a10g - NVIDIA A10G Tensor Core GPU
	//
	//   - l4 - NVIDIA L4 Tensor Core GPU
	//
	//   - l40s - NVIDIA L40S Tensor Core GPU
	//
	// This member is required.
	Name AcceleratorName

	// Specifies the runtime driver to use for the GPU accelerator. You must use the
	// same runtime for all GPUs.
	//
	// You can choose from the following runtimes:
	//
	//   - latest - Use the latest runtime available for the chip. If you specify
	//   latest and a new version of the runtime is released, the new version of the
	//   runtime is used.
	//
	//   - grid:r570 - [NVIDIA vGPU software 18]
	//
	//   - grid:r535 - [NVIDIA vGPU software 16]
	//
	// If you don't specify a runtime, Deadline Cloud uses latest as the default.
	// However, if you have multiple accelerators and specify latest for some and
	// leave others blank, Deadline Cloud raises an exception.
	//
	// [NVIDIA vGPU software 16]: https://docs.nvidia.com/vgpu/16.0/index.html
	// [NVIDIA vGPU software 18]: https://docs.nvidia.com/vgpu/18.0/index.html
	Runtime *string
	// contains filtered or unexported fields
}

Describes a specific GPU accelerator required for an Amazon Elastic Compute Cloud worker host.

type AcceleratorTotalMemoryMiBRange 

type AcceleratorTotalMemoryMiBRange struct {

	// The minimum amount of memory to use for the accelerator, measured in MiB.
	//
	// This member is required.
	Min *int32

	// The maximum amount of memory to use for the accelerator, measured in MiB.
	Max *int32
	// contains filtered or unexported fields
}

Defines the maximum and minimum amount of memory, in MiB, to use for the accelerator.

type AcceleratorType 

type AcceleratorType string
const (
	// GPU accelerator type.
	AcceleratorTypeGpu AcceleratorType = "gpu"
)

Enum values for AcceleratorType

func (AcceleratorType) Values 

func (AcceleratorType) Values() []AcceleratorType

Values returns all known values for AcceleratorType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AccessDeniedException 

type AccessDeniedException struct {
	Message *string

	ErrorCodeOverride *string

	Context map[string]string
	// contains filtered or unexported fields
}

You don't have permission to perform the action.

func (*AccessDeniedException) Error 

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode 

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault 

func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault

func (*AccessDeniedException) ErrorMessage 

func (e *AccessDeniedException) ErrorMessage() string

type AcquiredLimit added in v1.8.0 

type AcquiredLimit struct {

	// The number of limit resources used.
	//
	// This member is required.
	Count *int32

	// The unique identifier of the limit.
	//
	// This member is required.
	LimitId *string
	// contains filtered or unexported fields
}

Provides information about the number of resources used.

type AssignedEnvironmentEnterSessionActionDefinition 

type AssignedEnvironmentEnterSessionActionDefinition struct {

	// The environment ID of the assigned environment at the start of a session.
	//
	// This member is required.
	EnvironmentId *string
	// contains filtered or unexported fields
}

The assigned starting environment for a worker during session.

type AssignedEnvironmentExitSessionActionDefinition 

type AssignedEnvironmentExitSessionActionDefinition struct {

	// The environment ID of the assigned environment when exiting a session.
	//
	// This member is required.
	EnvironmentId *string
	// contains filtered or unexported fields
}

The assigned environment when a worker exits a session.

type AssignedSession 

type AssignedSession struct {

	// The job ID for the assigned session.
	//
	// This member is required.
	JobId *string

	// The log configuration for the worker's assigned session.
	//
	// This member is required.
	LogConfiguration *LogConfiguration

	// The queue ID of the assigned session.
	//
	// This member is required.
	QueueId *string

	// The session actions to apply to the assigned session.
	//
	// This member is required.
	SessionActions []AssignedSessionAction
	// contains filtered or unexported fields
}

The assigned session for the worker.

type AssignedSessionAction 

type AssignedSessionAction struct {

	// The definition of the assigned session action.
	//
	// This member is required.
	Definition AssignedSessionActionDefinition

	// The session action ID for the assigned session.
	//
	// This member is required.
	SessionActionId *string
	// contains filtered or unexported fields
}

The action for a session defined by the session action ID.

type AssignedSessionActionDefinition 

type AssignedSessionActionDefinition interface {
	// contains filtered or unexported methods
}

The definition of the assigned session action.

The following types satisfy this interface: 

AssignedSessionActionDefinitionMemberEnvEnter
AssignedSessionActionDefinitionMemberEnvExit
AssignedSessionActionDefinitionMemberSyncInputJobAttachments
AssignedSessionActionDefinitionMemberTaskRun
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/deadline/types"
)

func main() {
	var union types.AssignedSessionActionDefinition
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.AssignedSessionActionDefinitionMemberEnvEnter:
		_ = v.Value // Value is types.AssignedEnvironmentEnterSessionActionDefinition

	case *types.AssignedSessionActionDefinitionMemberEnvExit:
		_ = v.Value // Value is types.AssignedEnvironmentExitSessionActionDefinition

	case *types.AssignedSessionActionDefinitionMemberSyncInputJobAttachments:
		_ = v.Value // Value is types.AssignedSyncInputJobAttachmentsSessionActionDefinition

	case *types.AssignedSessionActionDefinitionMemberTaskRun:
		_ = v.Value // Value is types.AssignedTaskRunSessionActionDefinition

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type AssignedSessionActionDefinitionMemberEnvEnter 

type AssignedSessionActionDefinitionMemberEnvEnter struct {
	Value AssignedEnvironmentEnterSessionActionDefinition
	// contains filtered or unexported fields
}

The environment a session starts on.

type AssignedSessionActionDefinitionMemberEnvExit 

type AssignedSessionActionDefinitionMemberEnvExit struct {
	Value AssignedEnvironmentExitSessionActionDefinition
	// contains filtered or unexported fields
}

The environment a session exits from.

type AssignedSessionActionDefinitionMemberSyncInputJobAttachments 

type AssignedSessionActionDefinitionMemberSyncInputJobAttachments struct {
	Value AssignedSyncInputJobAttachmentsSessionActionDefinition
	// contains filtered or unexported fields
}

The job attachment to sync with an assigned session action.

type AssignedSessionActionDefinitionMemberTaskRun 

type AssignedSessionActionDefinitionMemberTaskRun struct {
	Value AssignedTaskRunSessionActionDefinition
	// contains filtered or unexported fields
}

The task run.

type AssignedSyncInputJobAttachmentsSessionActionDefinition 

type AssignedSyncInputJobAttachmentsSessionActionDefinition struct {

	// The step ID.
	StepId *string
	// contains filtered or unexported fields
}

The details for an assigned session action as it relates to a job attachment.

type AssignedTaskRunSessionActionDefinition 

type AssignedTaskRunSessionActionDefinition struct {

	// The parameters to include.
	//
	// This member is required.
	Parameters map[string]TaskParameterValue

	// The step ID.
	//
	// This member is required.
	StepId *string

	// The task ID.
	TaskId *string
	// contains filtered or unexported fields
}

The specific task, step, and parameters to include.

type Attachments 

type Attachments struct {

	// A list of manifests which describe job attachment configurations.
	//
	// This member is required.
	Manifests []ManifestProperties

	// The file system.
	FileSystem JobAttachmentsFileSystem
	// contains filtered or unexported fields
}

The attachments for jobs.

type AutoScalingMode 

type AutoScalingMode string
const (
	AutoScalingModeNoScaling             AutoScalingMode = "NO_SCALING"
	AutoScalingModeEventBasedAutoScaling AutoScalingMode = "EVENT_BASED_AUTO_SCALING"
)

Enum values for AutoScalingMode

func (AutoScalingMode) Values 

func (AutoScalingMode) Values() []AutoScalingMode

Values returns all known values for AutoScalingMode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AutoScalingStatus 

type AutoScalingStatus string
const (
	AutoScalingStatusGrowing   AutoScalingStatus = "GROWING"
	AutoScalingStatusSteady    AutoScalingStatus = "STEADY"
	AutoScalingStatusShrinking AutoScalingStatus = "SHRINKING"
)

Enum values for AutoScalingStatus

func (AutoScalingStatus) Values 

func (AutoScalingStatus) Values() []AutoScalingStatus

Values returns all known values for AutoScalingStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AwsCredentials 

type AwsCredentials struct {

	// The IAM access key ID.
	//
	// This member is required.
	AccessKeyId *string

	// The expiration date and time of the IAM credentials.
	//
	// This member is required.
	Expiration *time.Time

	// The IAM secret access key.
	//
	// This member is required.
	SecretAccessKey *string

	// The IAM session token
	//
	// This member is required.
	SessionToken *string
	// contains filtered or unexported fields
}

The Identity and Access Management credentials.

type BudgetActionToAdd 

type BudgetActionToAdd struct {

	// The percentage threshold for the budget action to add.
	//
	// This member is required.
	ThresholdPercentage *float32

	// The type of budget action to add.
	//
	// This member is required.
	Type BudgetActionType

	// A description for the budget action to add.
	//
	// 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.
	Description *string
	// contains filtered or unexported fields
}

The budget action to add.

type BudgetActionToRemove 

type BudgetActionToRemove struct {

	// The percentage threshold for the budget action to remove.
	//
	// This member is required.
	ThresholdPercentage *float32

	// The type of budget action to remove.
	//
	// This member is required.
	Type BudgetActionType
	// contains filtered or unexported fields
}

The budget action to remove.

type BudgetActionType 

type BudgetActionType string
const (
	BudgetActionTypeStopSchedulingAndCompleteTasks BudgetActionType = "STOP_SCHEDULING_AND_COMPLETE_TASKS"
	BudgetActionTypeStopSchedulingAndCancelTasks   BudgetActionType = "STOP_SCHEDULING_AND_CANCEL_TASKS"
)

Enum values for BudgetActionType

func (BudgetActionType) Values 

func (BudgetActionType) Values() []BudgetActionType

Values returns all known values for BudgetActionType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type BudgetSchedule 

type BudgetSchedule interface {
	// contains filtered or unexported methods
}

The start and end time of the budget.

The following types satisfy this interface: 

BudgetScheduleMemberFixed
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/deadline/types"
)

func main() {
	var union types.BudgetSchedule
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.BudgetScheduleMemberFixed:
		_ = v.Value // Value is types.FixedBudgetSchedule

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type BudgetScheduleMemberFixed 

type BudgetScheduleMemberFixed struct {
	Value FixedBudgetSchedule
	// contains filtered or unexported fields
}

The fixed start and end time of the budget's schedule.

type BudgetStatus 

type BudgetStatus string
const (
	BudgetStatusActive   BudgetStatus = "ACTIVE"
	BudgetStatusInactive BudgetStatus = "INACTIVE"
)

Enum values for BudgetStatus

func (BudgetStatus) Values 

func (BudgetStatus) Values() []BudgetStatus

Values returns all known values for BudgetStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type BudgetSummary 

type BudgetSummary struct {

	// The approximate dollar limit of the budget.
	//
	// This member is required.
	ApproximateDollarLimit *float32

	// The budget ID.
	//
	// This member is required.
	BudgetId *string

	// The date and time the resource was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The user or system that created this resource.
	//
	// This member is required.
	CreatedBy *string

	// The display name of the budget summary to update.
	//
	// 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.
	//
	// This member is required.
	DisplayName *string

	// The status of the budget.
	//
	//   - ACTIVE –The budget is being evaluated.
	//
	//   - INACTIVE –The budget is inactive. This can include Expired, Canceled, or
	//   deleted Deleted statuses.
	//
	// This member is required.
	Status BudgetStatus

	// The resource used to track expenditure in the budget.
	//
	// This member is required.
	UsageTrackingResource UsageTrackingResource

	// The consumed usage for the budget.
	//
	// This member is required.
	Usages *ConsumedUsages

	// The description of the budget summary.
	//
	// 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.
	//
	// Deprecated: ListBudgets no longer supports description. Use GetBudget if
	// description is needed.
	Description *string

	// The date and time the resource was updated.
	UpdatedAt *time.Time

	// The user or system that updated this resource.
	UpdatedBy *string
	// contains filtered or unexported fields
}

The budget summary.

type ComparisonOperator 

type ComparisonOperator string
const (
	ComparisonOperatorEqual              ComparisonOperator = "EQUAL"
	ComparisonOperatorNotEqual           ComparisonOperator = "NOT_EQUAL"
	ComparisonOperatorGreaterThanEqualTo ComparisonOperator = "GREATER_THAN_EQUAL_TO"
	ComparisonOperatorGreaterThan        ComparisonOperator = "GREATER_THAN"
	ComparisonOperatorLessThanEqualTo    ComparisonOperator = "LESS_THAN_EQUAL_TO"
	ComparisonOperatorLessThan           ComparisonOperator = "LESS_THAN"
)

Enum values for ComparisonOperator

func (ComparisonOperator) Values 

func (ComparisonOperator) Values() []ComparisonOperator

Values returns all known values for ComparisonOperator. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type CompletedStatus 

type CompletedStatus string
const (
	CompletedStatusSucceeded      CompletedStatus = "SUCCEEDED"
	CompletedStatusFailed         CompletedStatus = "FAILED"
	CompletedStatusInterrupted    CompletedStatus = "INTERRUPTED"
	CompletedStatusCanceled       CompletedStatus = "CANCELED"
	CompletedStatusNeverAttempted CompletedStatus = "NEVER_ATTEMPTED"
)

Enum values for CompletedStatus

func (CompletedStatus) Values 

func (CompletedStatus) Values() []CompletedStatus

Values returns all known values for CompletedStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ConflictException 

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string

	Reason       ConflictExceptionReason
	ResourceId   *string
	ResourceType *string
	Context      map[string]string
	// contains filtered or unexported fields
}

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

func (*ConflictException) Error 

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode 

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault 

func (e *ConflictException) ErrorFault() smithy.ErrorFault

func (*ConflictException) ErrorMessage 

func (e *ConflictException) ErrorMessage() string

type ConflictExceptionReason 

type ConflictExceptionReason string
const (
	ConflictExceptionReasonConflictException      ConflictExceptionReason = "CONFLICT_EXCEPTION"
	ConflictExceptionReasonConcurrentModification ConflictExceptionReason = "CONCURRENT_MODIFICATION"
	ConflictExceptionReasonResourceAlreadyExists  ConflictExceptionReason = "RESOURCE_ALREADY_EXISTS"
	ConflictExceptionReasonResourceInUse          ConflictExceptionReason = "RESOURCE_IN_USE"
	ConflictExceptionReasonStatusConflict         ConflictExceptionReason = "STATUS_CONFLICT"
)

Enum values for ConflictExceptionReason

func (ConflictExceptionReason) Values 

func (ConflictExceptionReason) Values() []ConflictExceptionReason

Values returns all known values for ConflictExceptionReason. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ConsumedUsages 

type ConsumedUsages struct {

	// The amount of the budget consumed.
	//
	// This member is required.
	ApproximateDollarUsage *float32
	// contains filtered or unexported fields
}

The consumed usage for the resource.

type CpuArchitectureType 

type CpuArchitectureType string
const (
	CpuArchitectureTypeX8664 CpuArchitectureType = "x86_64"
	CpuArchitectureTypeArm64 CpuArchitectureType = "arm64"
)

Enum values for CpuArchitectureType

func (CpuArchitectureType) Values 

func (CpuArchitectureType) Values() []CpuArchitectureType

Values returns all known values for CpuArchitectureType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type CreateJobTargetTaskRunStatus 

type CreateJobTargetTaskRunStatus string
const (
	CreateJobTargetTaskRunStatusReady     CreateJobTargetTaskRunStatus = "READY"
	CreateJobTargetTaskRunStatusSuspended CreateJobTargetTaskRunStatus = "SUSPENDED"
)

Enum values for CreateJobTargetTaskRunStatus

func (CreateJobTargetTaskRunStatus) Values 

func (CreateJobTargetTaskRunStatus) Values() []CreateJobTargetTaskRunStatus

Values returns all known values for CreateJobTargetTaskRunStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type CustomerManagedFleetConfiguration 

type CustomerManagedFleetConfiguration struct {

	// The Auto Scaling mode for the customer managed fleet configuration.
	//
	// This member is required.
	Mode AutoScalingMode

	// The worker capabilities for a customer managed fleet configuration.
	//
	// This member is required.
	WorkerCapabilities *CustomerManagedWorkerCapabilities

	// The storage profile ID.
	StorageProfileId *string

	// Specifies whether tags associated with a fleet are attached to workers when the
	// worker is launched.
	//
	// When the tagPropagationMode is set to PROPAGATE_TAGS_TO_WORKERS_AT_LAUNCH any
	// tag associated with a fleet is attached to workers when they launch. If the tags
	// for a fleet change, the tags associated with running workers do not change.
	//
	// If you don't specify tagPropagationMode , the default is NO_PROPAGATION .
	TagPropagationMode TagPropagationMode
	// contains filtered or unexported fields
}

The details of a customer managed fleet configuration.

type CustomerManagedFleetOperatingSystemFamily 

type CustomerManagedFleetOperatingSystemFamily string
const (
	CustomerManagedFleetOperatingSystemFamilyWindows CustomerManagedFleetOperatingSystemFamily = "WINDOWS"
	CustomerManagedFleetOperatingSystemFamilyLinux   CustomerManagedFleetOperatingSystemFamily = "LINUX"
	CustomerManagedFleetOperatingSystemFamilyMacos   CustomerManagedFleetOperatingSystemFamily = "MACOS"
)

Enum values for CustomerManagedFleetOperatingSystemFamily

func (CustomerManagedFleetOperatingSystemFamily) Values 

func (CustomerManagedFleetOperatingSystemFamily) Values() []CustomerManagedFleetOperatingSystemFamily

Values returns all known values for CustomerManagedFleetOperatingSystemFamily. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type CustomerManagedWorkerCapabilities 

type CustomerManagedWorkerCapabilities struct {

	// The CPU architecture type for the customer managed worker capabilities.
	//
	// This member is required.
	CpuArchitectureType CpuArchitectureType

	// The memory (MiB).
	//
	// This member is required.
	MemoryMiB *MemoryMiBRange

	// The operating system (OS) family.
	//
	// This member is required.
	OsFamily CustomerManagedFleetOperatingSystemFamily

	// The vCPU count for the customer manged worker capabilities.
	//
	// This member is required.
	VCpuCount *VCpuCountRange

	// The range of the accelerator.
	AcceleratorCount *AcceleratorCountRange

	// The total memory (MiB) for the customer managed worker capabilities.
	AcceleratorTotalMemoryMiB *AcceleratorTotalMemoryMiBRange

	// The accelerator types for the customer managed worker capabilities.
	AcceleratorTypes []AcceleratorType

	// Custom requirement ranges for customer managed worker capabilities.
	CustomAmounts []FleetAmountCapability

	// Custom attributes for the customer manged worker capabilities.
	CustomAttributes []FleetAttributeCapability
	// contains filtered or unexported fields
}

The worker capabilities for a customer managed workflow.

type DateTimeFilterExpression 

type DateTimeFilterExpression struct {

	// The date and time.
	//
	// This member is required.
	DateTime *time.Time

	// The name of the date-time field to filter on.
	//
	// This member is required.
	Name *string

	// The type of comparison to use to filter the results.
	//
	// This member is required.
	Operator ComparisonOperator
	// contains filtered or unexported fields
}

The time stamp in date-time format.

type DeadlinePrincipalType 

type DeadlinePrincipalType string
const (
	DeadlinePrincipalTypeUser  DeadlinePrincipalType = "USER"
	DeadlinePrincipalTypeGroup DeadlinePrincipalType = "GROUP"
)

Enum values for DeadlinePrincipalType

func (DeadlinePrincipalType) Values 

func (DeadlinePrincipalType) Values() []DeadlinePrincipalType

Values returns all known values for DeadlinePrincipalType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DefaultQueueBudgetAction 

type DefaultQueueBudgetAction string
const (
	DefaultQueueBudgetActionNone                           DefaultQueueBudgetAction = "NONE"
	DefaultQueueBudgetActionStopSchedulingAndCompleteTasks DefaultQueueBudgetAction = "STOP_SCHEDULING_AND_COMPLETE_TASKS"
	DefaultQueueBudgetActionStopSchedulingAndCancelTasks   DefaultQueueBudgetAction = "STOP_SCHEDULING_AND_CANCEL_TASKS"
)

Enum values for DefaultQueueBudgetAction

func (DefaultQueueBudgetAction) Values 

func (DefaultQueueBudgetAction) Values() []DefaultQueueBudgetAction

Values returns all known values for DefaultQueueBudgetAction. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DependencyConsumerResolutionStatus 

type DependencyConsumerResolutionStatus string
const (
	DependencyConsumerResolutionStatusResolved   DependencyConsumerResolutionStatus = "RESOLVED"
	DependencyConsumerResolutionStatusUnresolved DependencyConsumerResolutionStatus = "UNRESOLVED"
)

Enum values for DependencyConsumerResolutionStatus

func (DependencyConsumerResolutionStatus) Values 

func (DependencyConsumerResolutionStatus) Values() []DependencyConsumerResolutionStatus

Values returns all known values for DependencyConsumerResolutionStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DependencyCounts 

type DependencyCounts struct {

	// The number of consumers resolved.
	//
	// This member is required.
	ConsumersResolved *int32

	// The number of unresolved consumers.
	//
	// This member is required.
	ConsumersUnresolved *int32

	// The number of resolved dependencies.
	//
	// This member is required.
	DependenciesResolved *int32

	// The number of unresolved dependencies.
	//
	// This member is required.
	DependenciesUnresolved *int32
	// contains filtered or unexported fields
}

The number of dependencies for the consumer.

type DesiredWorkerStatus 

type DesiredWorkerStatus string
const (
	DesiredWorkerStatusStopped DesiredWorkerStatus = "STOPPED"
)

Enum values for DesiredWorkerStatus

func (DesiredWorkerStatus) Values 

func (DesiredWorkerStatus) Values() []DesiredWorkerStatus

Values returns all known values for DesiredWorkerStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Ec2EbsVolume 

type Ec2EbsVolume struct {

	// The IOPS per volume.
	Iops *int32

	// The EBS volume size in GiB.
	SizeGiB *int32

	// The throughput per volume in MiB.
	ThroughputMiB *int32
	// contains filtered or unexported fields
}

Specifies the EBS volume.

type Ec2MarketType 

type Ec2MarketType string
const (
	Ec2MarketTypeOnDemand    Ec2MarketType = "on-demand"
	Ec2MarketTypeSpot        Ec2MarketType = "spot"
	Ec2MarketTypeWaitAndSave Ec2MarketType = "wait-and-save"
)

Enum values for Ec2MarketType

func (Ec2MarketType) Values 

func (Ec2MarketType) Values() []Ec2MarketType

Values returns all known values for Ec2MarketType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type EnvironmentDetailsEntity 

type EnvironmentDetailsEntity struct {

	// The environment ID.
	//
	// This member is required.
	EnvironmentId *string

	// The job ID.
	//
	// This member is required.
	JobId *string

	// The schema version in the environment.
	//
	// This member is required.
	SchemaVersion *string

	// The template used for the environment.
	//
	// This member is required.
	Template document.Interface
	// contains filtered or unexported fields
}

The details of a specified environment.

type EnvironmentDetailsError 

type EnvironmentDetailsError struct {

	// The error code.
	//
	// This member is required.
	Code JobEntityErrorCode

	// The environment ID.
	//
	// This member is required.
	EnvironmentId *string

	// The job ID.
	//
	// This member is required.
	JobId *string

	// The error message detailing the error's cause.
	//
	// This member is required.
	Message *string
	// contains filtered or unexported fields
}

The error details for the environment.

type EnvironmentDetailsIdentifiers 

type EnvironmentDetailsIdentifiers struct {

	// The environment ID.
	//
	// This member is required.
	EnvironmentId *string

	// The job ID.
	//
	// This member is required.
	JobId *string
	// contains filtered or unexported fields
}

The IDs of the job and environment.

type EnvironmentEnterSessionActionDefinition 

type EnvironmentEnterSessionActionDefinition struct {

	// The environment ID.
	//
	// This member is required.
	EnvironmentId *string
	// contains filtered or unexported fields
}

The environment ID to use to enter a session action.

type EnvironmentEnterSessionActionDefinitionSummary 

type EnvironmentEnterSessionActionDefinitionSummary struct {

	// The environment ID.
	//
	// This member is required.
	EnvironmentId *string
	// contains filtered or unexported fields
}

Defines the environment a session action enters in.

type EnvironmentExitSessionActionDefinition 

type EnvironmentExitSessionActionDefinition struct {

	// The environment ID.
	//
	// This member is required.
	EnvironmentId *string
	// contains filtered or unexported fields
}

Defines the environment a session action exits from.

type EnvironmentExitSessionActionDefinitionSummary 

type EnvironmentExitSessionActionDefinitionSummary struct {

	// The environment ID.
	//
	// This member is required.
	EnvironmentId *string
	// contains filtered or unexported fields
}

A summary of the environment details for which a session action to exits.

type EnvironmentTemplateType 

type EnvironmentTemplateType string
const (
	EnvironmentTemplateTypeJson EnvironmentTemplateType = "JSON"
	EnvironmentTemplateTypeYaml EnvironmentTemplateType = "YAML"
)

Enum values for EnvironmentTemplateType

func (EnvironmentTemplateType) Values 

func (EnvironmentTemplateType) Values() []EnvironmentTemplateType

Values returns all known values for EnvironmentTemplateType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type FarmMember 

type FarmMember struct {

	// The farm ID of the farm member.
	//
	// This member is required.
	FarmId *string

	// The identity store ID of the farm member.
	//
	// This member is required.
	IdentityStoreId *string

	// The farm member's membership level.
	//
	// This member is required.
	MembershipLevel MembershipLevel

	// The principal ID of the farm member.
	//
	// This member is required.
	PrincipalId *string

	// The principal type of the farm member.
	//
	// This member is required.
	PrincipalType DeadlinePrincipalType
	// contains filtered or unexported fields
}

The member of a farm.

type FarmSummary 

type FarmSummary struct {

	// The date and time the resource was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The user or system that created this resource.
	//
	// This member is required.
	CreatedBy *string

	// The display name of the farm.
	//
	// 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.
	//
	// This member is required.
	DisplayName *string

	// The farm ID.
	//
	// This member is required.
	FarmId *string

	// The ARN for the KMS key.
	KmsKeyArn *string

	// The date and time the resource was updated.
	UpdatedAt *time.Time

	// The user or system that updated this resource.
	UpdatedBy *string
	// contains filtered or unexported fields
}

The summary of details for a farm.

type FieldSortExpression 

type FieldSortExpression struct {

	// The name of the field.
	//
	// This member is required.
	Name *string

	// The sort order for the field.
	//
	// This member is required.
	SortOrder SortOrder
	// contains filtered or unexported fields
}

The field sorting order and name of the field.

type FileSystemLocation 

type FileSystemLocation struct {

	// The location name.
	//
	// This member is required.
	Name *string

	// The file path.
	//
	// This member is required.
	Path *string

	// The type of file.
	//
	// This member is required.
	Type FileSystemLocationType
	// contains filtered or unexported fields
}

The details of the file system location for the resource.

type FileSystemLocationType 

type FileSystemLocationType string
const (
	FileSystemLocationTypeShared FileSystemLocationType = "SHARED"
	FileSystemLocationTypeLocal  FileSystemLocationType = "LOCAL"
)

Enum values for FileSystemLocationType

func (FileSystemLocationType) Values 

func (FileSystemLocationType) Values() []FileSystemLocationType

Values returns all known values for FileSystemLocationType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type FixedBudgetSchedule 

type FixedBudgetSchedule struct {

	// When the budget ends.
	//
	// This member is required.
	EndTime *time.Time

	// When the budget starts.
	//
	// This member is required.
	StartTime *time.Time
	// contains filtered or unexported fields
}

The details of a fixed budget schedule.

type FleetAmountCapability 

type FleetAmountCapability struct {

	// The minimum amount of fleet worker capability.
	//
	// This member is required.
	Min *float32

	// The name of the fleet capability.
	//
	// This member is required.
	Name *string

	// The maximum amount of the fleet worker capability.
	Max *float32
	// contains filtered or unexported fields
}

The fleet amount and attribute capabilities.

type FleetAttributeCapability 

type FleetAttributeCapability struct {

	// The name of the fleet attribute capability for the worker.
	//
	// This member is required.
	Name *string

	// The number of fleet attribute capabilities.
	//
	// This member is required.
	Values []string
	// contains filtered or unexported fields
}

Defines the fleet's capability name, minimum, and maximum.

type FleetCapabilities 

type FleetCapabilities struct {

	// Amount capabilities of the fleet.
	Amounts []FleetAmountCapability

	// Attribute capabilities of the fleet.
	Attributes []FleetAttributeCapability
	// contains filtered or unexported fields
}

The amounts and attributes of fleets.

type FleetConfiguration 

type FleetConfiguration interface {
	// contains filtered or unexported methods
}

Fleet configuration details.

The following types satisfy this interface: 

FleetConfigurationMemberCustomerManaged
FleetConfigurationMemberServiceManagedEc2
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/deadline/types"
)

func main() {
	var union types.FleetConfiguration
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.FleetConfigurationMemberCustomerManaged:
		_ = v.Value // Value is types.CustomerManagedFleetConfiguration

	case *types.FleetConfigurationMemberServiceManagedEc2:
		_ = v.Value // Value is types.ServiceManagedEc2FleetConfiguration

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type FleetConfigurationMemberCustomerManaged 

type FleetConfigurationMemberCustomerManaged struct {
	Value CustomerManagedFleetConfiguration
	// contains filtered or unexported fields
}

The customer managed fleets within a fleet configuration.

type FleetConfigurationMemberServiceManagedEc2 

type FleetConfigurationMemberServiceManagedEc2 struct {
	Value ServiceManagedEc2FleetConfiguration
	// contains filtered or unexported fields
}

The service managed Amazon EC2 instances for a fleet configuration.

type FleetMember 

type FleetMember struct {

	// The farm ID.
	//
	// This member is required.
	FarmId *string

	// The fleet ID.
	//
	// This member is required.
	FleetId *string

	// The identity store ID.
	//
	// This member is required.
	IdentityStoreId *string

	// The fleet member's membership level.
	//
	// This member is required.
	MembershipLevel MembershipLevel

	// The principal ID of the fleet member.
	//
	// This member is required.
	PrincipalId *string

	// The principal type of the fleet member.
	//
	// This member is required.
	PrincipalType DeadlinePrincipalType
	// contains filtered or unexported fields
}

The fleet member.

type FleetStatus 

type FleetStatus string
const (
	FleetStatusActive           FleetStatus = "ACTIVE"
	FleetStatusCreateInProgress FleetStatus = "CREATE_IN_PROGRESS"
	FleetStatusUpdateInProgress FleetStatus = "UPDATE_IN_PROGRESS"
	FleetStatusCreateFailed     FleetStatus = "CREATE_FAILED"
	FleetStatusUpdateFailed     FleetStatus = "UPDATE_FAILED"
	FleetStatusSuspended        FleetStatus = "SUSPENDED"
)

Enum values for FleetStatus

func (FleetStatus) Values 

func (FleetStatus) Values() []FleetStatus

Values returns all known values for FleetStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type FleetSummary 

type FleetSummary struct {

	// The configuration details for the fleet.
	//
	// This member is required.
	Configuration FleetConfiguration

	// The date and time the resource was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The user or system that created this resource.
	//
	// This member is required.
	CreatedBy *string

	// The display name of the fleet summary to update.
	//
	// 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.
	//
	// This member is required.
	DisplayName *string

	// The farm ID.
	//
	// This member is required.
	FarmId *string

	// The fleet ID.
	//
	// This member is required.
	FleetId *string

	// The maximum number of workers specified in the fleet.
	//
	// This member is required.
	MaxWorkerCount *int32

	// The minimum number of workers in the fleet.
	//
	// This member is required.
	MinWorkerCount *int32

	// The status of the fleet.
	//
	// This member is required.
	Status FleetStatus

	// The number of workers in the fleet summary.
	//
	// This member is required.
	WorkerCount *int32

	// The Auto Scaling status of a fleet.
	AutoScalingStatus AutoScalingStatus

	// A message that communicates a suspended status of the fleet.
	StatusMessage *string

	// The target number of workers in a fleet.
	TargetWorkerCount *int32

	// The date and time the resource was updated.
	UpdatedAt *time.Time

	// The user or system that updated this resource.
	UpdatedBy *string
	// contains filtered or unexported fields
}

The details of a fleet.

type GetJobEntityError 

type GetJobEntityError interface {
	// contains filtered or unexported methods
}

The error for the job entity.

The following types satisfy this interface: 

GetJobEntityErrorMemberEnvironmentDetails
GetJobEntityErrorMemberJobAttachmentDetails
GetJobEntityErrorMemberJobDetails
GetJobEntityErrorMemberStepDetails
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/deadline/types"
)

func main() {
	var union types.GetJobEntityError
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.GetJobEntityErrorMemberEnvironmentDetails:
		_ = v.Value // Value is types.EnvironmentDetailsError

	case *types.GetJobEntityErrorMemberJobAttachmentDetails:
		_ = v.Value // Value is types.JobAttachmentDetailsError

	case *types.GetJobEntityErrorMemberJobDetails:
		_ = v.Value // Value is types.JobDetailsError

	case *types.GetJobEntityErrorMemberStepDetails:
		_ = v.Value // Value is types.StepDetailsError

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type GetJobEntityErrorMemberEnvironmentDetails 

type GetJobEntityErrorMemberEnvironmentDetails struct {
	Value EnvironmentDetailsError
	// contains filtered or unexported fields
}

The environment details for the failed job entity.

type GetJobEntityErrorMemberJobAttachmentDetails 

type GetJobEntityErrorMemberJobAttachmentDetails struct {
	Value JobAttachmentDetailsError
	// contains filtered or unexported fields
}

The job attachment details for the failed job entity.

type GetJobEntityErrorMemberJobDetails 

type GetJobEntityErrorMemberJobDetails struct {
	Value JobDetailsError
	// contains filtered or unexported fields
}

The job details for the failed job entity.

type GetJobEntityErrorMemberStepDetails 

type GetJobEntityErrorMemberStepDetails struct {
	Value StepDetailsError
	// contains filtered or unexported fields
}

The step details for the failed job entity.

type HostConfiguration added in v1.12.0 

type HostConfiguration struct {

	// The text of the script that runs as a worker is starting up that you can use to
	// provide additional configuration for workers in your fleet. The script runs
	// after a worker enters the STARTING state and before the worker processes tasks.
	//
	// For more information about using the script, see [Run scripts as an administrator to configure workers] in the Deadline Cloud
	// Developer Guide.
	//
	// The script runs as an administrative user ( sudo root on Linux, as an
	// Administrator on Windows).
	//
	// [Run scripts as an administrator to configure workers]: https://docs.aws.amazon.com/deadline-cloud/latest/developerguide/smf-admin.html
	//
	// This member is required.
	ScriptBody *string

	// The maximum time that the host configuration can run. If the timeout expires,
	// the worker enters the NOT RESPONDING state and shuts down. You are charged for
	// the time that the worker is running the host configuration script.
	//
	// You should configure your fleet for a maximum of one worker while testing your
	// host configuration script to avoid starting additional workers.
	//
	// The default is 300 seconds (5 minutes).
	ScriptTimeoutSeconds *int32
	// contains filtered or unexported fields
}

Provides a script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.

To remove a script from a fleet, use the UpdateFleet operation with the hostConfiguration scriptBody parameter set to an empty string ("").

type HostPropertiesRequest 

type HostPropertiesRequest struct {

	// The host name.
	HostName *string

	// The IP address of the host.
	IpAddresses *IpAddresses
	// contains filtered or unexported fields
}

The host property details.

type HostPropertiesResponse 

type HostPropertiesResponse struct {

	// The ARN of the host EC2 instance.
	Ec2InstanceArn *string

	// The instance type of the host EC2 instance.
	Ec2InstanceType *string

	// The host name.
	HostName *string

	// The IP address of the host.
	IpAddresses *IpAddresses
	// contains filtered or unexported fields
}

The host property details.

type InternalServerErrorException 

type InternalServerErrorException struct {
	Message *string

	ErrorCodeOverride *string

	RetryAfterSeconds *int32
	// contains filtered or unexported fields
}

Deadline Cloud can't process your request right now. Try again later.

func (*InternalServerErrorException) Error 

func (e *InternalServerErrorException) Error() string

func (*InternalServerErrorException) ErrorCode 

func (e *InternalServerErrorException) ErrorCode() string

func (*InternalServerErrorException) ErrorFault 

func (e *InternalServerErrorException) ErrorFault() smithy.ErrorFault

func (*InternalServerErrorException) ErrorMessage 

func (e *InternalServerErrorException) ErrorMessage() string

type IpAddresses 

type IpAddresses struct {

	// The IpV4 address of the network.
	IpV4Addresses []string

	// The IpV6 address for the network and node component.
	IpV6Addresses []string
	// contains filtered or unexported fields
}

The IP addresses for a host.

type JobAttachmentDetailsEntity 

type JobAttachmentDetailsEntity struct {

	// The job attachments.
	//
	// This member is required.
	Attachments *Attachments

	// The job ID.
	//
	// This member is required.
	JobId *string
	// contains filtered or unexported fields
}

The job attachments.

type JobAttachmentDetailsError 

type JobAttachmentDetailsError struct {

	// The error code.
	//
	// This member is required.
	Code JobEntityErrorCode

	// The job ID.
	//
	// This member is required.
	JobId *string

	// The error message detailing the error's cause.
	//
	// This member is required.
	Message *string
	// contains filtered or unexported fields
}

The error details for job attachments.

type JobAttachmentDetailsIdentifiers 

type JobAttachmentDetailsIdentifiers struct {

	// The job ID.
	//
	// This member is required.
	JobId *string
	// contains filtered or unexported fields
}

Identifier details for job attachments.

type JobAttachmentSettings 

type JobAttachmentSettings struct {

	// The root prefix.
	//
	// This member is required.
	RootPrefix *string

	// The Amazon S3 bucket name.
	//
	// This member is required.
	S3BucketName *string
	// contains filtered or unexported fields
}

The job attachment settings. These are the Amazon S3 bucket name and the Amazon S3 prefix.

type JobAttachmentsFileSystem 

type JobAttachmentsFileSystem string
const (
	JobAttachmentsFileSystemCopied  JobAttachmentsFileSystem = "COPIED"
	JobAttachmentsFileSystemVirtual JobAttachmentsFileSystem = "VIRTUAL"
)

Enum values for JobAttachmentsFileSystem

func (JobAttachmentsFileSystem) Values 

func (JobAttachmentsFileSystem) Values() []JobAttachmentsFileSystem

Values returns all known values for JobAttachmentsFileSystem. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type JobDetailsEntity 

type JobDetailsEntity struct {

	// The job ID.
	//
	// This member is required.
	JobId *string

	// The log group name.
	//
	// This member is required.
	LogGroupName *string

	// The schema version.
	//
	// This member is required.
	SchemaVersion *string

	// The job attachment settings.
	JobAttachmentSettings *JobAttachmentSettings

	// The user name and group that the job uses when run.
	JobRunAsUser *JobRunAsUser

	// The parameters.
	Parameters map[string]JobParameter

	// The path mapping rules.
	PathMappingRules []PathMappingRule

	// The queue role ARN.
	QueueRoleArn *string
	// contains filtered or unexported fields
}

The job details for a specific job.

type JobDetailsError 

type JobDetailsError struct {

	// The error code.
	//
	// This member is required.
	Code JobEntityErrorCode

	// The job ID.
	//
	// This member is required.
	JobId *string

	// The error message detailing the error's cause.
	//
	// This member is required.
	Message *string
	// contains filtered or unexported fields
}

The details of a job error.

type JobDetailsIdentifiers 

type JobDetailsIdentifiers struct {

	// The job ID.
	//
	// This member is required.
	JobId *string
	// contains filtered or unexported fields
}

The identifiers for a job.

type JobEntity 

type JobEntity interface {
	// contains filtered or unexported methods
}

The details of a job entity.

The following types satisfy this interface: 

JobEntityMemberEnvironmentDetails
JobEntityMemberJobAttachmentDetails
JobEntityMemberJobDetails
JobEntityMemberStepDetails
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/deadline/types"
)

func main() {
	var union types.JobEntity
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.JobEntityMemberEnvironmentDetails:
		_ = v.Value // Value is types.EnvironmentDetailsEntity

	case *types.JobEntityMemberJobAttachmentDetails:
		_ = v.Value // Value is types.JobAttachmentDetailsEntity

	case *types.JobEntityMemberJobDetails:
		_ = v.Value // Value is types.JobDetailsEntity

	case *types.JobEntityMemberStepDetails:
		_ = v.Value // Value is types.StepDetailsEntity

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type JobEntityErrorCode 

type JobEntityErrorCode string
const (
	JobEntityErrorCodeAccessDeniedException     JobEntityErrorCode = "AccessDeniedException"
	JobEntityErrorCodeInternalServerException   JobEntityErrorCode = "InternalServerException"
	JobEntityErrorCodeValidationException       JobEntityErrorCode = "ValidationException"
	JobEntityErrorCodeResourceNotFoundException JobEntityErrorCode = "ResourceNotFoundException"
	JobEntityErrorCodeMaxPayloadSizeExceeded    JobEntityErrorCode = "MaxPayloadSizeExceeded"
	JobEntityErrorCodeConflictException         JobEntityErrorCode = "ConflictException"
)

Enum values for JobEntityErrorCode

func (JobEntityErrorCode) Values 

func (JobEntityErrorCode) Values() []JobEntityErrorCode

Values returns all known values for JobEntityErrorCode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type JobEntityIdentifiersUnion 

type JobEntityIdentifiersUnion interface {
	// contains filtered or unexported methods
}

The details of a job entity identifier.

The following types satisfy this interface: 

JobEntityIdentifiersUnionMemberEnvironmentDetails
JobEntityIdentifiersUnionMemberJobAttachmentDetails
JobEntityIdentifiersUnionMemberJobDetails
JobEntityIdentifiersUnionMemberStepDetails
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/deadline/types"
)

func main() {
	var union types.JobEntityIdentifiersUnion
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.JobEntityIdentifiersUnionMemberEnvironmentDetails:
		_ = v.Value // Value is types.EnvironmentDetailsIdentifiers

	case *types.JobEntityIdentifiersUnionMemberJobAttachmentDetails:
		_ = v.Value // Value is types.JobAttachmentDetailsIdentifiers

	case *types.JobEntityIdentifiersUnionMemberJobDetails:
		_ = v.Value // Value is types.JobDetailsIdentifiers

	case *types.JobEntityIdentifiersUnionMemberStepDetails:
		_ = v.Value // Value is types.StepDetailsIdentifiers

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type JobEntityIdentifiersUnionMemberEnvironmentDetails 

type JobEntityIdentifiersUnionMemberEnvironmentDetails struct {
	Value EnvironmentDetailsIdentifiers
	// contains filtered or unexported fields
}

The environment details.

type JobEntityIdentifiersUnionMemberJobAttachmentDetails 

type JobEntityIdentifiersUnionMemberJobAttachmentDetails struct {
	Value JobAttachmentDetailsIdentifiers
	// contains filtered or unexported fields
}

The job attachment details.

type JobEntityIdentifiersUnionMemberJobDetails 

type JobEntityIdentifiersUnionMemberJobDetails struct {
	Value JobDetailsIdentifiers
	// contains filtered or unexported fields
}

The job details.

type JobEntityIdentifiersUnionMemberStepDetails 

type JobEntityIdentifiersUnionMemberStepDetails struct {
	Value StepDetailsIdentifiers
	// contains filtered or unexported fields
}

The step details.

type JobEntityMemberEnvironmentDetails 

type JobEntityMemberEnvironmentDetails struct {
	Value EnvironmentDetailsEntity
	// contains filtered or unexported fields
}

The environment details for the job entity.

type JobEntityMemberJobAttachmentDetails 

type JobEntityMemberJobAttachmentDetails struct {
	Value JobAttachmentDetailsEntity
	// contains filtered or unexported fields
}

The job attachment details.

type JobEntityMemberJobDetails 

type JobEntityMemberJobDetails struct {
	Value JobDetailsEntity
	// contains filtered or unexported fields
}

The job details.

type JobEntityMemberStepDetails 

type JobEntityMemberStepDetails struct {
	Value StepDetailsEntity
	// contains filtered or unexported fields
}

The step details.

type JobLifecycleStatus 

type JobLifecycleStatus string
const (
	JobLifecycleStatusCreateInProgress JobLifecycleStatus = "CREATE_IN_PROGRESS"
	JobLifecycleStatusCreateFailed     JobLifecycleStatus = "CREATE_FAILED"
	JobLifecycleStatusCreateComplete   JobLifecycleStatus = "CREATE_COMPLETE"
	JobLifecycleStatusUploadInProgress JobLifecycleStatus = "UPLOAD_IN_PROGRESS"
	JobLifecycleStatusUploadFailed     JobLifecycleStatus = "UPLOAD_FAILED"
	JobLifecycleStatusUpdateInProgress JobLifecycleStatus = "UPDATE_IN_PROGRESS"
	JobLifecycleStatusUpdateFailed     JobLifecycleStatus = "UPDATE_FAILED"
	JobLifecycleStatusUpdateSucceeded  JobLifecycleStatus = "UPDATE_SUCCEEDED"
	JobLifecycleStatusArchived         JobLifecycleStatus = "ARCHIVED"
)

Enum values for JobLifecycleStatus

func (JobLifecycleStatus) Values 

func (JobLifecycleStatus) Values() []JobLifecycleStatus

Values returns all known values for JobLifecycleStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type JobMember 

type JobMember struct {

	// The farm ID.
	//
	// This member is required.
	FarmId *string

	// The identity store ID.
	//
	// This member is required.
	IdentityStoreId *string

	// The job ID.
	//
	// This member is required.
	JobId *string

	// The job member's membership level.
	//
	// This member is required.
	MembershipLevel MembershipLevel

	// The principal ID of the job member.
	//
	// This member is required.
	PrincipalId *string

	// The principal type of the job member.
	//
	// This member is required.
	PrincipalType DeadlinePrincipalType

	// The queue ID.
	//
	// This member is required.
	QueueId *string
	// contains filtered or unexported fields
}

The details for a job member.

type JobParameter 

type JobParameter interface {
	// contains filtered or unexported methods
}

The details of job parameters.

The following types satisfy this interface: 

JobParameterMemberFloat
JobParameterMemberInt
JobParameterMemberPath
JobParameterMemberString
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/deadline/types"
)

func main() {
	var union types.JobParameter
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.JobParameterMemberFloat:
		_ = v.Value // Value is string

	case *types.JobParameterMemberInt:
		_ = v.Value // Value is string

	case *types.JobParameterMemberPath:
		_ = v.Value // Value is string

	case *types.JobParameterMemberString:
		_ = v.Value // Value is string

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type JobParameterMemberFloat 

type JobParameterMemberFloat struct {
	Value string
	// contains filtered or unexported fields
}

A double precision IEEE-754 floating point number represented as a string.

type JobParameterMemberInt 

type JobParameterMemberInt struct {
	Value string
	// contains filtered or unexported fields
}

A signed integer represented as a string.

type JobParameterMemberPath 

type JobParameterMemberPath struct {
	Value string
	// contains filtered or unexported fields
}

A file system path represented as a string.

type JobParameterMemberString 

type JobParameterMemberString struct {
	Value string
	// contains filtered or unexported fields
}

A UTF-8 string.

type JobRunAsUser 

type JobRunAsUser struct {

	// Specifies whether the job should run using the queue's system user or if the
	// job should run using the worker agent system user.
	//
	// This member is required.
	RunAs RunAs

	// The user and group that the jobs in the queue run as.
	Posix *PosixUser

	// Identifies a Microsoft Windows user.
	Windows *WindowsUser
	// contains filtered or unexported fields
}

Identifies the user for a job.

type JobSearchSummary 

type JobSearchSummary struct {

	// The date and time the resource was created.
	CreatedAt *time.Time

	// The user or system that created this resource.
	CreatedBy *string

	// The date and time the resource ended running.
	EndedAt *time.Time

	// The job ID.
	JobId *string

	// The job parameters.
	JobParameters map[string]JobParameter

	// The life cycle status.
	LifecycleStatus JobLifecycleStatus

	// The life cycle status message.
	LifecycleStatusMessage *string

	// The number of task failures before the job stops running and is marked as FAILED
	// .
	MaxFailedTasksCount *int32

	// The maximum number of retries for a job.
	MaxRetriesPerTask *int32

	// The maximum number of worker hosts that can concurrently process a job. When
	// the maxWorkerCount is reached, no more workers will be assigned to process the
	// job, even if the fleets assigned to the job's queue has available workers.
	//
	// You can't set the maxWorkerCount to 0. If you set it to -1, there is no maximum
	// number of workers.
	//
	// If you don't specify the maxWorkerCount , the default is -1.
	MaxWorkerCount *int32

	// The job name.
	Name *string

	// The job priority.
	Priority *int32

	// The queue ID.
	QueueId *string

	// The job ID for the source job.
	SourceJobId *string

	// The date and time the resource started running.
	StartedAt *time.Time

	// The task status to start with on the job.
	TargetTaskRunStatus JobTargetTaskRunStatus

	// The total number of times tasks from the job failed and were retried.
	TaskFailureRetryCount *int32

	// The task run status for the job.
	//
	//   - PENDING –pending and waiting for resources.
	//
	//   - READY –ready to be processed.
	//
	//   - ASSIGNED –assigned and will run next on a worker.
	//
	//   - SCHEDULED –scheduled to be run on a worker.
	//
	//   - INTERRUPTING –being interrupted.
	//
	//   - RUNNING –running on a worker.
	//
	//   - SUSPENDED –the task is suspended.
	//
	//   - CANCELED –the task has been canceled.
	//
	//   - FAILED –the task has failed.
	//
	//   - SUCCEEDED –the task has succeeded.
	TaskRunStatus TaskRunStatus

	// The number of tasks running on the job.
	TaskRunStatusCounts map[string]int32

	// The date and time the resource was updated.
	UpdatedAt *time.Time

	// The user or system that updated this resource.
	UpdatedBy *string
	// contains filtered or unexported fields
}

The details of a job search.

type JobSummary 

type JobSummary struct {

	// The date and time the resource was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The user or system that created this resource.
	//
	// This member is required.
	CreatedBy *string

	// The job ID.
	//
	// This member is required.
	JobId *string

	// The life cycle status.
	//
	// This member is required.
	LifecycleStatus JobLifecycleStatus

	// The life cycle status message.
	//
	// This member is required.
	LifecycleStatusMessage *string

	// The job name.
	//
	// This member is required.
	Name *string

	// The job priority.
	//
	// This member is required.
	Priority *int32

	// The date and time the resource ended running.
	EndedAt *time.Time

	// The number of task failures before the job stops running and is marked as FAILED
	// .
	MaxFailedTasksCount *int32

	// The maximum number of retries for a job.
	MaxRetriesPerTask *int32

	// The maximum number of worker hosts that can concurrently process a job. When
	// the maxWorkerCount is reached, no more workers will be assigned to process the
	// job, even if the fleets assigned to the job's queue has available workers.
	//
	// You can't set the maxWorkerCount to 0. If you set it to -1, there is no maximum
	// number of workers.
	//
	// If you don't specify the maxWorkerCount , the default is -1.
	MaxWorkerCount *int32

	// The job ID for the source job.
	SourceJobId *string

	// The date and time the resource started running.
	StartedAt *time.Time

	// The task status to start with on the job.
	TargetTaskRunStatus JobTargetTaskRunStatus

	// The total number of times tasks from the job failed and were retried.
	TaskFailureRetryCount *int32

	// The task run status for the job.
	//
	//   - PENDING –pending and waiting for resources.
	//
	//   - READY –ready to be processed.
	//
	//   - ASSIGNED –assigned and will run next on a worker.
	//
	//   - SCHEDULED –scheduled to be run on a worker.
	//
	//   - INTERRUPTING –being interrupted.
	//
	//   - RUNNING –running on a worker.
	//
	//   - SUSPENDED –the task is suspended.
	//
	//   - CANCELED –the task has been canceled.
	//
	//   - FAILED –the task has failed.
	//
	//   - SUCCEEDED –the task has succeeded.
	TaskRunStatus TaskRunStatus

	// The number of tasks running on the job.
	TaskRunStatusCounts map[string]int32

	// The date and time the resource was updated.
	UpdatedAt *time.Time

	// The user or system that updated this resource.
	UpdatedBy *string
	// contains filtered or unexported fields
}

A summary of job details.

type JobTargetTaskRunStatus 

type JobTargetTaskRunStatus string
const (
	JobTargetTaskRunStatusReady     JobTargetTaskRunStatus = "READY"
	JobTargetTaskRunStatusFailed    JobTargetTaskRunStatus = "FAILED"
	JobTargetTaskRunStatusSucceeded JobTargetTaskRunStatus = "SUCCEEDED"
	JobTargetTaskRunStatusCanceled  JobTargetTaskRunStatus = "CANCELED"
	JobTargetTaskRunStatusSuspended JobTargetTaskRunStatus = "SUSPENDED"
	JobTargetTaskRunStatusPending   JobTargetTaskRunStatus = "PENDING"
)

Enum values for JobTargetTaskRunStatus

func (JobTargetTaskRunStatus) Values 

func (JobTargetTaskRunStatus) Values() []JobTargetTaskRunStatus

Values returns all known values for JobTargetTaskRunStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type JobTemplateType 

type JobTemplateType string
const (
	JobTemplateTypeJson JobTemplateType = "JSON"
	JobTemplateTypeYaml JobTemplateType = "YAML"
)

Enum values for JobTemplateType

func (JobTemplateType) Values 

func (JobTemplateType) Values() []JobTemplateType

Values returns all known values for JobTemplateType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type LicenseEndpointStatus 

type LicenseEndpointStatus string
const (
	LicenseEndpointStatusCreateInProgress LicenseEndpointStatus = "CREATE_IN_PROGRESS"
	LicenseEndpointStatusDeleteInProgress LicenseEndpointStatus = "DELETE_IN_PROGRESS"
	LicenseEndpointStatusReady            LicenseEndpointStatus = "READY"
	LicenseEndpointStatusNotReady         LicenseEndpointStatus = "NOT_READY"
)

Enum values for LicenseEndpointStatus

func (LicenseEndpointStatus) Values 

func (LicenseEndpointStatus) Values() []LicenseEndpointStatus

Values returns all known values for LicenseEndpointStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type LicenseEndpointSummary 

type LicenseEndpointSummary struct {

	// The license endpoint ID.
	LicenseEndpointId *string

	// The status of the license endpoint.
	Status LicenseEndpointStatus

	// The status message of the license endpoint.
	StatusMessage *string

	// The VCP(virtual private cloud) ID associated with the license endpoint.
	VpcId *string
	// contains filtered or unexported fields
}

The details for a license endpoint.

type LimitSummary added in v1.8.0 

type LimitSummary struct {

	// The value that you specify as the name in the amounts field of the
	// hostRequirements in a step of a job template to declare the limit requirement.
	//
	// This member is required.
	AmountRequirementName *string

	// The Unix timestamp of the date and time that the limit was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The user identifier of the person that created the limit.
	//
	// This member is required.
	CreatedBy *string

	// The number of resources from the limit that are being used by jobs. The result
	// is delayed and may not be the count at the time that you called the operation.
	//
	// This member is required.
	CurrentCount *int32

	// The name of the limit used in lists to identify the limit.
	//
	// 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.
	//
	// This member is required.
	DisplayName *string

	// The unique identifier of the farm that contains the limit.
	//
	// This member is required.
	FarmId *string

	// The unique identifier of the limit.
	//
	// This member is required.
	LimitId *string

	// The maximum number of resources constrained by this limit. When all of the
	// resources are in use, steps that require the limit won't be scheduled until the
	// resource is available.
	//
	// The maxValue must not be 0. If the value is -1, there is no restriction on the
	// number of resources that can be acquired for this limit.
	//
	// This member is required.
	MaxCount *int32

	// The Unix timestamp of the date and time that the limit was last updated.
	UpdatedAt *time.Time

	// The user identifier of the person that last updated the limit.
	UpdatedBy *string
	// contains filtered or unexported fields
}

Provides information about a specific limit.

type LogConfiguration 

type LogConfiguration struct {

	// The log drivers for worker related logs.
	//
	// This member is required.
	LogDriver *string

	// The log configuration error details.
	Error *string

	// The options for a log driver.
	Options map[string]string

	// The parameters for the log configuration.
	Parameters map[string]string
	// contains filtered or unexported fields
}

Log configuration details.

type LogicalOperator 

type LogicalOperator string
const (
	LogicalOperatorAnd LogicalOperator = "AND"
	LogicalOperatorOr  LogicalOperator = "OR"
)

Enum values for LogicalOperator

func (LogicalOperator) Values 

func (LogicalOperator) Values() []LogicalOperator

Values returns all known values for LogicalOperator. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ManifestProperties 

type ManifestProperties struct {

	// The file's root path.
	//
	// This member is required.
	RootPath *string

	// The format of the root path.
	//
	// This member is required.
	RootPathFormat PathFormat

	// The file system location name.
	FileSystemLocationName *string

	// The hash value of the file.
	InputManifestHash *string

	// The file path.
	InputManifestPath *string

	// The file path relative to the directory.
	OutputRelativeDirectories []string
	// contains filtered or unexported fields
}

The details of the manifest that links a job's source information.

type MembershipLevel 

type MembershipLevel string
const (
	MembershipLevelViewer      MembershipLevel = "VIEWER"
	MembershipLevelContributor MembershipLevel = "CONTRIBUTOR"
	MembershipLevelOwner       MembershipLevel = "OWNER"
	MembershipLevelManager     MembershipLevel = "MANAGER"
)

Enum values for MembershipLevel

func (MembershipLevel) Values 

func (MembershipLevel) Values() []MembershipLevel

Values returns all known values for MembershipLevel. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type MemoryMiBRange 

type MemoryMiBRange struct {

	// The minimum amount of memory (in MiB).
	//
	// This member is required.
	Min *int32

	// The maximum amount of memory (in MiB).
	Max *int32
	// contains filtered or unexported fields
}

The range of memory in MiB.

type MeteredProductSummary 

type MeteredProductSummary struct {

	// The family to which the metered product belongs.
	//
	// This member is required.
	Family *string

	// The port on which the metered product should run.
	//
	// This member is required.
	Port *int32

	// The product ID.
	//
	// This member is required.
	ProductId *string

	// The vendor.
	//
	// This member is required.
	Vendor *string
	// contains filtered or unexported fields
}

The details of a metered product.

type MonitorSummary 

type MonitorSummary struct {

	// The UNIX timestamp of the date and time that the monitor was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The user name of the person that created the monitor.
	//
	// This member is required.
	CreatedBy *string

	// The name of the monitor that displays on the Deadline Cloud console.
	//
	// 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.
	//
	// This member is required.
	DisplayName *string

	// The Amazon Resource Name (ARN) that the IAM Identity Center assigned to the
	// monitor when it was created.
	//
	// This member is required.
	IdentityCenterApplicationArn *string

	// The Amazon Resource Name (ARN) of the IAM Identity Center instance responsible
	// for authenticating monitor users.
	//
	// This member is required.
	IdentityCenterInstanceArn *string

	// The unique identifier for the monitor.
	//
	// This member is required.
	MonitorId *string

	// The Amazon Resource Name (ARN) of the IAM role for the monitor. Users of the
	// monitor use this role to access Deadline Cloud resources.
	//
	// This member is required.
	RoleArn *string

	// The subdomain used for the monitor URL. The full URL of the monitor is
	// subdomain.Region.deadlinecloud.amazonaws.com.
	//
	// This member is required.
	Subdomain *string

	// The complete URL of the monitor. The full URL of the monitor is
	// subdomain.Region.deadlinecloud.amazonaws.com.
	//
	// This member is required.
	Url *string

	// The UNIX timestamp of the date and time that the monitor was last updated.
	UpdatedAt *time.Time

	// The user name of the person that last updated the monitor.
	UpdatedBy *string
	// contains filtered or unexported fields
}

Provides information about a monitor in Deadline Cloud.

type ParameterFilterExpression 

type ParameterFilterExpression struct {

	// The name of the parameter to filter on.
	//
	// This member is required.
	Name *string

	// The type of comparison to use to filter results.
	//
	// This member is required.
	Operator ComparisonOperator

	// The parameter's value.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

The details of a filtered search for parameters.

type ParameterSortExpression 

type ParameterSortExpression struct {

	// The parameter name to sort by.
	//
	// This member is required.
	Name *string

	// The sort order for the parameter.
	//
	// This member is required.
	SortOrder SortOrder
	// contains filtered or unexported fields
}

Organizes parameters according to your specifications.

type ParameterSpace 

type ParameterSpace struct {

	// The parameters to search for.
	//
	// This member is required.
	Parameters []StepParameter

	// The combination expression to use in the search.
	Combination *string
	// contains filtered or unexported fields
}

The details of a search for two or more step parameters.

type PathFormat 

type PathFormat string
const (
	PathFormatWindows PathFormat = "windows"
	PathFormatPosix   PathFormat = "posix"
)

Enum values for PathFormat

func (PathFormat) Values 

func (PathFormat) Values() []PathFormat

Values returns all known values for PathFormat. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type PathMappingRule 

type PathMappingRule struct {

	// The destination path.
	//
	// This member is required.
	DestinationPath *string

	// The source path.
	//
	// This member is required.
	SourcePath *string

	// The source path format.
	//
	// This member is required.
	SourcePathFormat PathFormat
	// contains filtered or unexported fields
}

The details of a source and destination path.

type Period 

type Period string
const (
	PeriodHourly  Period = "HOURLY"
	PeriodDaily   Period = "DAILY"
	PeriodWeekly  Period = "WEEKLY"
	PeriodMonthly Period = "MONTHLY"
)

Enum values for Period

func (Period) Values 

func (Period) Values() []Period

Values returns all known values for Period. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type PosixUser 

type PosixUser struct {

	// The name of the POSIX user's group.
	//
	// This member is required.
	Group *string

	// The name of the POSIX user.
	//
	// This member is required.
	User *string
	// contains filtered or unexported fields
}

The POSIX user.

type QueueBlockedReason 

type QueueBlockedReason string
const (
	QueueBlockedReasonNoBudgetConfigured     QueueBlockedReason = "NO_BUDGET_CONFIGURED"
	QueueBlockedReasonBudgetThresholdReached QueueBlockedReason = "BUDGET_THRESHOLD_REACHED"
)

Enum values for QueueBlockedReason

func (QueueBlockedReason) Values 

func (QueueBlockedReason) Values() []QueueBlockedReason

Values returns all known values for QueueBlockedReason. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type QueueEnvironmentSummary 

type QueueEnvironmentSummary struct {

	// The name of the queue environment.
	//
	// This member is required.
	Name *string

	// The queue environment's priority.
	//
	// This member is required.
	Priority *int32

	// The queue environment ID.
	//
	// This member is required.
	QueueEnvironmentId *string
	// contains filtered or unexported fields
}

The summary of a queue environment.

type QueueFleetAssociationStatus 

type QueueFleetAssociationStatus string
const (
	QueueFleetAssociationStatusActive                         QueueFleetAssociationStatus = "ACTIVE"
	QueueFleetAssociationStatusStopSchedulingAndCompleteTasks QueueFleetAssociationStatus = "STOP_SCHEDULING_AND_COMPLETE_TASKS"
	QueueFleetAssociationStatusStopSchedulingAndCancelTasks   QueueFleetAssociationStatus = "STOP_SCHEDULING_AND_CANCEL_TASKS"
	QueueFleetAssociationStatusStopped                        QueueFleetAssociationStatus = "STOPPED"
)

Enum values for QueueFleetAssociationStatus

func (QueueFleetAssociationStatus) Values 

func (QueueFleetAssociationStatus) Values() []QueueFleetAssociationStatus

Values returns all known values for QueueFleetAssociationStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type QueueFleetAssociationSummary 

type QueueFleetAssociationSummary struct {

	// The date and time the resource was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The user or system that created this resource.
	//
	// This member is required.
	CreatedBy *string

	// The fleet ID.
	//
	// This member is required.
	FleetId *string

	// The queue ID.
	//
	// This member is required.
	QueueId *string

	// The status of task scheduling in the queue-fleet association.
	//
	//   - ACTIVE –Association is active.
	//
	//   - STOP_SCHEDULING_AND_COMPLETE_TASKS –Association has stopped scheduling new
	//   tasks and is completing current tasks.
	//
	//   - STOP_SCHEDULING_AND_CANCEL_TASKS –Association has stopped scheduling new
	//   tasks and is canceling current tasks.
	//
	//   - STOPPED –Association has been stopped.
	//
	// This member is required.
	Status QueueFleetAssociationStatus

	// The date and time the resource was updated.
	UpdatedAt *time.Time

	// The user or system that updated this resource.
	UpdatedBy *string
	// contains filtered or unexported fields
}

The details of a queue-fleet association.

type QueueLimitAssociationStatus added in v1.8.0 

type QueueLimitAssociationStatus string
const (
	QueueLimitAssociationStatusActive                         QueueLimitAssociationStatus = "ACTIVE"
	QueueLimitAssociationStatusStopLimitUsageAndCompleteTasks QueueLimitAssociationStatus = "STOP_LIMIT_USAGE_AND_COMPLETE_TASKS"
	QueueLimitAssociationStatusStopLimitUsageAndCancelTasks   QueueLimitAssociationStatus = "STOP_LIMIT_USAGE_AND_CANCEL_TASKS"
	QueueLimitAssociationStatusStopped                        QueueLimitAssociationStatus = "STOPPED"
)

Enum values for QueueLimitAssociationStatus

func (QueueLimitAssociationStatus) Values added in v1.8.0 

func (QueueLimitAssociationStatus) Values() []QueueLimitAssociationStatus

Values returns all known values for QueueLimitAssociationStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type QueueLimitAssociationSummary added in v1.8.0 

type QueueLimitAssociationSummary struct {

	// The Unix timestamp of the date and time that the association was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The user identifier of the person that created the association.
	//
	// This member is required.
	CreatedBy *string

	// The unique identifier of the limit in the association.
	//
	// This member is required.
	LimitId *string

	// The unique identifier of the queue in the association.
	//
	// This member is required.
	QueueId *string

	// The status of task scheduling in the queue-limit association.
	//
	//   - ACTIVE - Association is active.
	//
	//   - STOP_LIMIT_USAGE_AND_COMPLETE_TASKS - Association has stopped scheduling new
	//   tasks and is completing current tasks.
	//
	//   - STOP_LIMIT_USAGE_AND_CANCEL_TASKS - Association has stopped scheduling new
	//   tasks and is canceling current tasks.
	//
	//   - STOPPED - Association has been stopped.
	//
	// This member is required.
	Status QueueLimitAssociationStatus

	// The Unix timestamp of the date and time that the association was last updated.
	UpdatedAt *time.Time

	// The user identifier of the person that updated the association.
	UpdatedBy *string
	// contains filtered or unexported fields
}

Provides information about the association between a queue and a limit.

type QueueMember 

type QueueMember struct {

	// The farm ID.
	//
	// This member is required.
	FarmId *string

	// The identity store ID.
	//
	// This member is required.
	IdentityStoreId *string

	// The queue member's membership level.
	//
	// This member is required.
	MembershipLevel MembershipLevel

	// The principal ID of the queue member.
	//
	// This member is required.
	PrincipalId *string

	// The principal type of the queue member.
	//
	// This member is required.
	PrincipalType DeadlinePrincipalType

	// The queue ID.
	//
	// This member is required.
	QueueId *string
	// contains filtered or unexported fields
}

The details of a queue member.

type QueueStatus 

type QueueStatus string
const (
	QueueStatusIdle              QueueStatus = "IDLE"
	QueueStatusScheduling        QueueStatus = "SCHEDULING"
	QueueStatusSchedulingBlocked QueueStatus = "SCHEDULING_BLOCKED"
)

Enum values for QueueStatus

func (QueueStatus) Values 

func (QueueStatus) Values() []QueueStatus

Values returns all known values for QueueStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type QueueSummary 

type QueueSummary struct {

	// The date and time the resource was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The user or system that created this resource.
	//
	// This member is required.
	CreatedBy *string

	// The default action taken on a queue summary if a budget wasn't configured.
	//
	// This member is required.
	DefaultBudgetAction DefaultQueueBudgetAction

	// The display name of the queue summary to update.
	//
	// 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.
	//
	// This member is required.
	DisplayName *string

	// The farm ID.
	//
	// This member is required.
	FarmId *string

	// The queue ID.
	//
	// This member is required.
	QueueId *string

	// That status of the queue.
	//
	// This member is required.
	Status QueueStatus

	// The reason the queue is blocked, if applicable.
	BlockedReason QueueBlockedReason

	// The date and time the resource was updated.
	UpdatedAt *time.Time

	// The user or system that updated this resource.
	UpdatedBy *string
	// contains filtered or unexported fields
}

The details of a queue summary.

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId   *string
	ResourceType *string
	Context      map[string]string
	// contains filtered or unexported fields
}

The requested resource can't be found.

func (*ResourceNotFoundException) Error 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault 

func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type ResponseBudgetAction 

type ResponseBudgetAction struct {

	// The percentage threshold for the budget.
	//
	// This member is required.
	ThresholdPercentage *float32

	// The action taken on the budget once scheduling stops.
	//
	// This member is required.
	Type BudgetActionType

	// The budget action description.
	//
	// 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.
	Description *string
	// contains filtered or unexported fields
}

The details of a budget action.

type RunAs 

type RunAs string
const (
	RunAsQueueConfiguredUser RunAs = "QUEUE_CONFIGURED_USER"
	RunAsWorkerAgentUser     RunAs = "WORKER_AGENT_USER"
)

Enum values for RunAs

func (RunAs) Values 

func (RunAs) Values() []RunAs

Values returns all known values for RunAs. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type S3Location 

type S3Location struct {

	// The name of the Amazon S3 bucket.
	//
	// This member is required.
	BucketName *string

	// The Amazon S3 object key that uniquely identifies the Amazon S3 bucket.
	//
	// This member is required.
	Key *string
	// contains filtered or unexported fields
}

The Amazon S3 location information.

type SearchFilterExpression 

type SearchFilterExpression interface {
	// contains filtered or unexported methods
}

The type of search filter to apply.

The following types satisfy this interface: 

SearchFilterExpressionMemberDateTimeFilter
SearchFilterExpressionMemberGroupFilter
SearchFilterExpressionMemberParameterFilter
SearchFilterExpressionMemberSearchTermFilter
SearchFilterExpressionMemberStringFilter
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/deadline/types"
)

func main() {
	var union types.SearchFilterExpression
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.SearchFilterExpressionMemberDateTimeFilter:
		_ = v.Value // Value is types.DateTimeFilterExpression

	case *types.SearchFilterExpressionMemberGroupFilter:
		_ = v.Value // Value is types.SearchGroupedFilterExpressions

	case *types.SearchFilterExpressionMemberParameterFilter:
		_ = v.Value // Value is types.ParameterFilterExpression

	case *types.SearchFilterExpressionMemberSearchTermFilter:
		_ = v.Value // Value is types.SearchTermFilterExpression

	case *types.SearchFilterExpressionMemberStringFilter:
		_ = v.Value // Value is types.StringFilterExpression

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type SearchFilterExpressionMemberDateTimeFilter 

type SearchFilterExpressionMemberDateTimeFilter struct {
	Value DateTimeFilterExpression
	// contains filtered or unexported fields
}

Filters based on date and time.

type SearchFilterExpressionMemberGroupFilter 

type SearchFilterExpressionMemberGroupFilter struct {
	Value SearchGroupedFilterExpressions
	// contains filtered or unexported fields
}

Filters by group.

type SearchFilterExpressionMemberParameterFilter 

type SearchFilterExpressionMemberParameterFilter struct {
	Value ParameterFilterExpression
	// contains filtered or unexported fields
}

Filters by parameter.

type SearchFilterExpressionMemberSearchTermFilter 

type SearchFilterExpressionMemberSearchTermFilter struct {
	Value SearchTermFilterExpression
	// contains filtered or unexported fields
}

Filters by a specified search term.

type SearchFilterExpressionMemberStringFilter 

type SearchFilterExpressionMemberStringFilter struct {
	Value StringFilterExpression
	// contains filtered or unexported fields
}

Filters by a string.

type SearchGroupedFilterExpressions 

type SearchGroupedFilterExpressions struct {

	// The filters to use for the search.
	//
	// This member is required.
	Filters []SearchFilterExpression

	// The operators to include in the search.
	//
	// This member is required.
	Operator LogicalOperator
	// contains filtered or unexported fields
}

The filter expression, AND or OR , to use when searching among a group of search strings in a resource.

You can use two groupings per search each within parenthesis () .

type SearchSortExpression 

type SearchSortExpression interface {
	// contains filtered or unexported methods
}

The resources to search.

The following types satisfy this interface: 

SearchSortExpressionMemberFieldSort
SearchSortExpressionMemberParameterSort
SearchSortExpressionMemberUserJobsFirst
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/deadline/types"
)

func main() {
	var union types.SearchSortExpression
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.SearchSortExpressionMemberFieldSort:
		_ = v.Value // Value is types.FieldSortExpression

	case *types.SearchSortExpressionMemberParameterSort:
		_ = v.Value // Value is types.ParameterSortExpression

	case *types.SearchSortExpressionMemberUserJobsFirst:
		_ = v.Value // Value is types.UserJobsFirst

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type SearchSortExpressionMemberFieldSort 

type SearchSortExpressionMemberFieldSort struct {
	Value FieldSortExpression
	// contains filtered or unexported fields
}

Options for sorting by a field.

type SearchSortExpressionMemberParameterSort 

type SearchSortExpressionMemberParameterSort struct {
	Value ParameterSortExpression
	// contains filtered or unexported fields
}

Options for sorting by a parameter.

type SearchSortExpressionMemberUserJobsFirst 

type SearchSortExpressionMemberUserJobsFirst struct {
	Value UserJobsFirst
	// contains filtered or unexported fields
}

Options for sorting a particular user's jobs first.

type SearchTermFilterExpression 

type SearchTermFilterExpression struct {

	// The term to search for.
	//
	// This member is required.
	SearchTerm *string

	// Specifies how Deadline Cloud matches your search term in the results. If you
	// don't specify a matchType the default is FUZZY_MATCH .
	//
	//   - FUZZY_MATCH - Matches if a portion of the search term is found in the result.
	//
	//   - CONTAINS - Matches if the exact search term is contained in the result.
	MatchType SearchTermMatchingType
	// contains filtered or unexported fields
}

Searches for a particular search term.

type SearchTermMatchingType added in v1.10.0 

type SearchTermMatchingType string
const (
	SearchTermMatchingTypeFuzzyMatch SearchTermMatchingType = "FUZZY_MATCH"
	SearchTermMatchingTypeContains   SearchTermMatchingType = "CONTAINS"
)

Enum values for SearchTermMatchingType

func (SearchTermMatchingType) Values added in v1.10.0 

func (SearchTermMatchingType) Values() []SearchTermMatchingType

Values returns all known values for SearchTermMatchingType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ServiceManagedEc2FleetConfiguration 

type ServiceManagedEc2FleetConfiguration struct {

	// The Amazon EC2 instance capabilities.
	//
	// This member is required.
	InstanceCapabilities *ServiceManagedEc2InstanceCapabilities

	// The Amazon EC2 market type.
	//
	// This member is required.
	InstanceMarketOptions *ServiceManagedEc2InstanceMarketOptions

	// The storage profile ID.
	StorageProfileId *string

	// The VPC configuration details for a service managed Amazon EC2 fleet.
	VpcConfiguration *VpcConfiguration
	// contains filtered or unexported fields
}

The configuration details for a service managed Amazon EC2 fleet.

type ServiceManagedEc2InstanceCapabilities 

type ServiceManagedEc2InstanceCapabilities struct {

	// The CPU architecture type.
	//
	// This member is required.
	CpuArchitectureType CpuArchitectureType

	// The memory, as MiB, for the Amazon EC2 instance type.
	//
	// This member is required.
	MemoryMiB *MemoryMiBRange

	// The operating system (OS) family.
	//
	// This member is required.
	OsFamily ServiceManagedFleetOperatingSystemFamily

	// The amount of vCPU to require for instances in this fleet.
	//
	// This member is required.
	VCpuCount *VCpuCountRange

	// Describes the GPU accelerator capabilities required for worker host instances
	// in this fleet.
	AcceleratorCapabilities *AcceleratorCapabilities

	// The allowable Amazon EC2 instance types.
	AllowedInstanceTypes []string

	// The custom capability amounts to require for instances in this fleet.
	CustomAmounts []FleetAmountCapability

	// The custom capability attributes to require for instances in this fleet.
	CustomAttributes []FleetAttributeCapability

	// The instance types to exclude from the fleet.
	ExcludedInstanceTypes []string

	// The root EBS volume.
	RootEbsVolume *Ec2EbsVolume
	// contains filtered or unexported fields
}

The Amazon EC2 instance capabilities.

type ServiceManagedEc2InstanceMarketOptions 

type ServiceManagedEc2InstanceMarketOptions struct {

	// The Amazon EC2 instance type.
	//
	// This member is required.
	Type Ec2MarketType
	// contains filtered or unexported fields
}

The details of the Amazon EC2 instance market options for a service managed fleet.

type ServiceManagedFleetOperatingSystemFamily 

type ServiceManagedFleetOperatingSystemFamily string
const (
	ServiceManagedFleetOperatingSystemFamilyWindows ServiceManagedFleetOperatingSystemFamily = "WINDOWS"
	ServiceManagedFleetOperatingSystemFamilyLinux   ServiceManagedFleetOperatingSystemFamily = "LINUX"
)

Enum values for ServiceManagedFleetOperatingSystemFamily

func (ServiceManagedFleetOperatingSystemFamily) Values 

func (ServiceManagedFleetOperatingSystemFamily) Values() []ServiceManagedFleetOperatingSystemFamily

Values returns all known values for ServiceManagedFleetOperatingSystemFamily. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ServiceQuotaExceededException 

type ServiceQuotaExceededException struct {
	Message *string

	ErrorCodeOverride *string

	Reason       ServiceQuotaExceededExceptionReason
	ResourceType *string
	ServiceCode  *string
	QuotaCode    *string
	ResourceId   *string
	Context      map[string]string
	// contains filtered or unexported fields
}

You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.

func (*ServiceQuotaExceededException) Error 

func (e *ServiceQuotaExceededException) Error() string

func (*ServiceQuotaExceededException) ErrorCode 

func (e *ServiceQuotaExceededException) ErrorCode() string

func (*ServiceQuotaExceededException) ErrorFault 

func (e *ServiceQuotaExceededException) ErrorFault() smithy.ErrorFault

func (*ServiceQuotaExceededException) ErrorMessage 

func (e *ServiceQuotaExceededException) ErrorMessage() string

type ServiceQuotaExceededExceptionReason 

type ServiceQuotaExceededExceptionReason string
const (
	ServiceQuotaExceededExceptionReasonServiceQuotaExceededException ServiceQuotaExceededExceptionReason = "SERVICE_QUOTA_EXCEEDED_EXCEPTION"
	ServiceQuotaExceededExceptionReasonKmsKeyLimitExceeded           ServiceQuotaExceededExceptionReason = "KMS_KEY_LIMIT_EXCEEDED"
	ServiceQuotaExceededExceptionReasonDependencyLimitExceeded       ServiceQuotaExceededExceptionReason = "DEPENDENCY_LIMIT_EXCEEDED"
)

Enum values for ServiceQuotaExceededExceptionReason

func (ServiceQuotaExceededExceptionReason) Values 

func (ServiceQuotaExceededExceptionReason) Values() []ServiceQuotaExceededExceptionReason

Values returns all known values for ServiceQuotaExceededExceptionReason. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type SessionActionDefinition 

type SessionActionDefinition interface {
	// contains filtered or unexported methods
}

The definition of the session action.

The following types satisfy this interface: 

SessionActionDefinitionMemberEnvEnter
SessionActionDefinitionMemberEnvExit
SessionActionDefinitionMemberSyncInputJobAttachments
SessionActionDefinitionMemberTaskRun
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/deadline/types"
)

func main() {
	var union types.SessionActionDefinition
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.SessionActionDefinitionMemberEnvEnter:
		_ = v.Value // Value is types.EnvironmentEnterSessionActionDefinition

	case *types.SessionActionDefinitionMemberEnvExit:
		_ = v.Value // Value is types.EnvironmentExitSessionActionDefinition

	case *types.SessionActionDefinitionMemberSyncInputJobAttachments:
		_ = v.Value // Value is types.SyncInputJobAttachmentsSessionActionDefinition

	case *types.SessionActionDefinitionMemberTaskRun:
		_ = v.Value // Value is types.TaskRunSessionActionDefinition

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type SessionActionDefinitionMemberEnvEnter 

type SessionActionDefinitionMemberEnvEnter struct {
	Value EnvironmentEnterSessionActionDefinition
	// contains filtered or unexported fields
}

The environment to enter into.

type SessionActionDefinitionMemberEnvExit 

type SessionActionDefinitionMemberEnvExit struct {
	Value EnvironmentExitSessionActionDefinition
	// contains filtered or unexported fields
}

The environment to exit from.

type SessionActionDefinitionMemberSyncInputJobAttachments 

type SessionActionDefinitionMemberSyncInputJobAttachments struct {
	Value SyncInputJobAttachmentsSessionActionDefinition
	// contains filtered or unexported fields
}

The job attachments to sync with a session action.

type SessionActionDefinitionMemberTaskRun 

type SessionActionDefinitionMemberTaskRun struct {
	Value TaskRunSessionActionDefinition
	// contains filtered or unexported fields
}

The task run in the session.

type SessionActionDefinitionSummary 

type SessionActionDefinitionSummary interface {
	// contains filtered or unexported methods
}

The details of a session action definition.

The following types satisfy this interface: 

SessionActionDefinitionSummaryMemberEnvEnter
SessionActionDefinitionSummaryMemberEnvExit
SessionActionDefinitionSummaryMemberSyncInputJobAttachments
SessionActionDefinitionSummaryMemberTaskRun
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/deadline/types"
)

func main() {
	var union types.SessionActionDefinitionSummary
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.SessionActionDefinitionSummaryMemberEnvEnter:
		_ = v.Value // Value is types.EnvironmentEnterSessionActionDefinitionSummary

	case *types.SessionActionDefinitionSummaryMemberEnvExit:
		_ = v.Value // Value is types.EnvironmentExitSessionActionDefinitionSummary

	case *types.SessionActionDefinitionSummaryMemberSyncInputJobAttachments:
		_ = v.Value // Value is types.SyncInputJobAttachmentsSessionActionDefinitionSummary

	case *types.SessionActionDefinitionSummaryMemberTaskRun:
		_ = v.Value // Value is types.TaskRunSessionActionDefinitionSummary

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type SessionActionDefinitionSummaryMemberEnvEnter 

type SessionActionDefinitionSummaryMemberEnvEnter struct {
	Value EnvironmentEnterSessionActionDefinitionSummary
	// contains filtered or unexported fields
}

The environment to enter into.

type SessionActionDefinitionSummaryMemberEnvExit 

type SessionActionDefinitionSummaryMemberEnvExit struct {
	Value EnvironmentExitSessionActionDefinitionSummary
	// contains filtered or unexported fields
}

The environment to exit from.

type SessionActionDefinitionSummaryMemberSyncInputJobAttachments 

type SessionActionDefinitionSummaryMemberSyncInputJobAttachments struct {
	Value SyncInputJobAttachmentsSessionActionDefinitionSummary
	// contains filtered or unexported fields
}

The job attachments to sync with the session action definition.

type SessionActionDefinitionSummaryMemberTaskRun 

type SessionActionDefinitionSummaryMemberTaskRun struct {
	Value TaskRunSessionActionDefinitionSummary
	// contains filtered or unexported fields
}

The task run.

type SessionActionStatus 

type SessionActionStatus string
const (
	SessionActionStatusAssigned       SessionActionStatus = "ASSIGNED"
	SessionActionStatusRunning        SessionActionStatus = "RUNNING"
	SessionActionStatusCanceling      SessionActionStatus = "CANCELING"
	SessionActionStatusSucceeded      SessionActionStatus = "SUCCEEDED"
	SessionActionStatusFailed         SessionActionStatus = "FAILED"
	SessionActionStatusInterrupted    SessionActionStatus = "INTERRUPTED"
	SessionActionStatusCanceled       SessionActionStatus = "CANCELED"
	SessionActionStatusNeverAttempted SessionActionStatus = "NEVER_ATTEMPTED"
	SessionActionStatusScheduled      SessionActionStatus = "SCHEDULED"
	SessionActionStatusReclaiming     SessionActionStatus = "RECLAIMING"
	SessionActionStatusReclaimed      SessionActionStatus = "RECLAIMED"
)

Enum values for SessionActionStatus

func (SessionActionStatus) Values 

func (SessionActionStatus) Values() []SessionActionStatus

Values returns all known values for SessionActionStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type SessionActionSummary 

type SessionActionSummary struct {

	// The session action definition.
	//
	// This member is required.
	Definition SessionActionDefinitionSummary

	// The session action ID.
	//
	// This member is required.
	SessionActionId *string

	// The status of the session action.
	//
	// This member is required.
	Status SessionActionStatus

	// The date and time the resource ended running.
	EndedAt *time.Time

	// The list of manifest properties that describe file attachments for the task run.
	Manifests []TaskRunManifestPropertiesResponse

	// The completion percentage for the session action.
	ProgressPercent *float32

	// The date and time the resource started running.
	StartedAt *time.Time

	// The Linux timestamp of the last date and time that the session action was
	// updated.
	WorkerUpdatedAt *time.Time
	// contains filtered or unexported fields
}

The details of a session action.

type SessionLifecycleStatus 

type SessionLifecycleStatus string
const (
	SessionLifecycleStatusStarted          SessionLifecycleStatus = "STARTED"
	SessionLifecycleStatusUpdateInProgress SessionLifecycleStatus = "UPDATE_IN_PROGRESS"
	SessionLifecycleStatusUpdateSucceeded  SessionLifecycleStatus = "UPDATE_SUCCEEDED"
	SessionLifecycleStatusUpdateFailed     SessionLifecycleStatus = "UPDATE_FAILED"
	SessionLifecycleStatusEnded            SessionLifecycleStatus = "ENDED"
)

Enum values for SessionLifecycleStatus

func (SessionLifecycleStatus) Values 

func (SessionLifecycleStatus) Values() []SessionLifecycleStatus

Values returns all known values for SessionLifecycleStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type SessionLifecycleTargetStatus 

type SessionLifecycleTargetStatus string
const (
	SessionLifecycleTargetStatusEnded SessionLifecycleTargetStatus = "ENDED"
)

Enum values for SessionLifecycleTargetStatus

func (SessionLifecycleTargetStatus) Values 

func (SessionLifecycleTargetStatus) Values() []SessionLifecycleTargetStatus

Values returns all known values for SessionLifecycleTargetStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type SessionSummary 

type SessionSummary struct {

	// The fleet ID.
	//
	// This member is required.
	FleetId *string

	// The life cycle status for the session.
	//
	// This member is required.
	LifecycleStatus SessionLifecycleStatus

	// The session ID.
	//
	// This member is required.
	SessionId *string

	// The date and time the resource started running.
	//
	// This member is required.
	StartedAt *time.Time

	// The worker ID.
	//
	// This member is required.
	WorkerId *string

	// The date and time the resource ended running.
	EndedAt *time.Time

	// The target life cycle status for the session.
	TargetLifecycleStatus SessionLifecycleTargetStatus

	// The date and time the resource was updated.
	UpdatedAt *time.Time

	// The user or system that updated this resource.
	UpdatedBy *string
	// contains filtered or unexported fields
}

The summary of a session.

type SessionsStatisticsAggregationStatus 

type SessionsStatisticsAggregationStatus string
const (
	SessionsStatisticsAggregationStatusInProgress SessionsStatisticsAggregationStatus = "IN_PROGRESS"
	SessionsStatisticsAggregationStatusTimeout    SessionsStatisticsAggregationStatus = "TIMEOUT"
	SessionsStatisticsAggregationStatusFailed     SessionsStatisticsAggregationStatus = "FAILED"
	SessionsStatisticsAggregationStatusCompleted  SessionsStatisticsAggregationStatus = "COMPLETED"
)

Enum values for SessionsStatisticsAggregationStatus

func (SessionsStatisticsAggregationStatus) Values 

func (SessionsStatisticsAggregationStatus) Values() []SessionsStatisticsAggregationStatus

Values returns all known values for SessionsStatisticsAggregationStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type SessionsStatisticsResources 

type SessionsStatisticsResources interface {
	// contains filtered or unexported methods
}

Specifies the fleet IDs or queue IDs to return statistics. You can specify only fleet IDs or queue IDS, not both.

The following types satisfy this interface: 

SessionsStatisticsResourcesMemberFleetIds
SessionsStatisticsResourcesMemberQueueIds
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/deadline/types"
)

func main() {
	var union types.SessionsStatisticsResources
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.SessionsStatisticsResourcesMemberFleetIds:
		_ = v.Value // Value is []string

	case *types.SessionsStatisticsResourcesMemberQueueIds:
		_ = v.Value // Value is []string

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type SessionsStatisticsResourcesMemberFleetIds 

type SessionsStatisticsResourcesMemberFleetIds struct {
	Value []string
	// contains filtered or unexported fields
}

One to 10 fleet IDs that specify the fleets to return statistics for. If you specify the fleetIds field, you can't specify the queueIds field.

type SessionsStatisticsResourcesMemberQueueIds 

type SessionsStatisticsResourcesMemberQueueIds struct {
	Value []string
	// contains filtered or unexported fields
}

One to 10 queue IDs that specify the queues to return statistics for. If you specify the queueIds field, you can't specify the fleetIds field.

type SortOrder 

type SortOrder string
const (
	SortOrderAscending  SortOrder = "ASCENDING"
	SortOrderDescending SortOrder = "DESCENDING"
)

Enum values for SortOrder

func (SortOrder) Values 

func (SortOrder) Values() []SortOrder

Values returns all known values for SortOrder. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Statistics 

type Statistics struct {

	// How the statistics should appear in USD. Options include: minimum, maximum,
	// average or sum.
	//
	// This member is required.
	CostInUsd *Stats

	// The number of instances in a list of statistics.
	//
	// This member is required.
	Count *int32

	// The total aggregated runtime.
	//
	// This member is required.
	RuntimeInSeconds *Stats

	// The end time for the aggregation.
	AggregationEndTime *time.Time

	// The start time for the aggregation.
	AggregationStartTime *time.Time

	// The fleet ID.
	FleetId *string

	// The type of instance.
	InstanceType *string

	// The job ID.
	JobId *string

	// The job name.
	JobName *string

	// The licensed product.
	LicenseProduct *string

	// The queue ID.
	QueueId *string

	// The type of usage for the statistics.
	UsageType UsageType

	// The user ID.
	UserId *string
	// contains filtered or unexported fields
}

A list of statistics for a session.

type Stats 

type Stats struct {

	// The average of the usage statistics.
	Avg *float64

	// The maximum among the usage statistics.
	Max *float64

	// The minimum of the usage statistics.
	Min *float64

	// The sum of the usage statistics.
	Sum *float64
	// contains filtered or unexported fields
}

The minimum, maximum, average, and sum.

type StepAmountCapability 

type StepAmountCapability struct {

	// The name of the step.
	//
	// This member is required.
	Name *string

	// The maximum amount.
	Max *float64

	// The minimum amount.
	Min *float64

	// The amount value.
	Value *float64
	// contains filtered or unexported fields
}

The details outlining the minimum and maximum capability of a step.

type StepAttributeCapability 

type StepAttributeCapability struct {

	// The name of the step attribute.
	//
	// This member is required.
	Name *string

	// Requires all of the step attribute values.
	AllOf []string

	// Requires any of the step attributes in a given list.
	AnyOf []string
	// contains filtered or unexported fields
}

The list of step attributes.

type StepConsumer 

type StepConsumer struct {

	// The step consumer status.
	//
	// This member is required.
	Status DependencyConsumerResolutionStatus

	// The step ID.
	//
	// This member is required.
	StepId *string
	// contains filtered or unexported fields
}

The details of a step consumer.

type StepDependency 

type StepDependency struct {

	// The step dependency status.
	//
	// This member is required.
	Status DependencyConsumerResolutionStatus

	// The step ID.
	//
	// This member is required.
	StepId *string
	// contains filtered or unexported fields
}

The details of step dependency.

type StepDetailsEntity 

type StepDetailsEntity struct {

	// The dependencies for a step.
	//
	// This member is required.
	Dependencies []string

	// The job ID.
	//
	// This member is required.
	JobId *string

	// The schema version for a step template.
	//
	// This member is required.
	SchemaVersion *string

	// The step ID.
	//
	// This member is required.
	StepId *string

	// The template for a step.
	//
	// This member is required.
	Template document.Interface
	// contains filtered or unexported fields
}

The details of a step entity.

type StepDetailsError 

type StepDetailsError struct {

	// The error code.
	//
	// This member is required.
	Code JobEntityErrorCode

	// The job ID.
	//
	// This member is required.
	JobId *string

	// The error message detailing the error's cause.
	//
	// This member is required.
	Message *string

	// The step ID.
	//
	// This member is required.
	StepId *string
	// contains filtered or unexported fields
}

The details of the step error.

type StepDetailsIdentifiers 

type StepDetailsIdentifiers struct {

	// The job ID.
	//
	// This member is required.
	JobId *string

	// The step ID.
	//
	// This member is required.
	StepId *string
	// contains filtered or unexported fields
}

The details of identifiers for a step.

type StepLifecycleStatus 

type StepLifecycleStatus string
const (
	StepLifecycleStatusCreateComplete   StepLifecycleStatus = "CREATE_COMPLETE"
	StepLifecycleStatusUpdateInProgress StepLifecycleStatus = "UPDATE_IN_PROGRESS"
	StepLifecycleStatusUpdateFailed     StepLifecycleStatus = "UPDATE_FAILED"
	StepLifecycleStatusUpdateSucceeded  StepLifecycleStatus = "UPDATE_SUCCEEDED"
)

Enum values for StepLifecycleStatus

func (StepLifecycleStatus) Values 

func (StepLifecycleStatus) Values() []StepLifecycleStatus

Values returns all known values for StepLifecycleStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type StepParameter 

type StepParameter struct {

	// The name of the parameter.
	//
	// This member is required.
	Name *string

	// The data type of the parameter.
	//
	// This member is required.
	Type StepParameterType
	// contains filtered or unexported fields
}

The details of a step parameter.

type StepParameterType 

type StepParameterType string
const (
	StepParameterTypeInt      StepParameterType = "INT"
	StepParameterTypeFloat    StepParameterType = "FLOAT"
	StepParameterTypeString   StepParameterType = "STRING"
	StepParameterTypePath     StepParameterType = "PATH"
	StepParameterTypeChunkInt StepParameterType = "CHUNK_INT"
)

Enum values for StepParameterType

func (StepParameterType) Values 

func (StepParameterType) Values() []StepParameterType

Values returns all known values for StepParameterType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type StepRequiredCapabilities 

type StepRequiredCapabilities struct {

	// The capability amounts that the step requires.
	//
	// This member is required.
	Amounts []StepAmountCapability

	// The capability attributes that the step requires.
	//
	// This member is required.
	Attributes []StepAttributeCapability
	// contains filtered or unexported fields
}

The details of required step capabilities.

type StepSearchSummary 

type StepSearchSummary struct {

	// The date and time the resource was created.
	CreatedAt *time.Time

	// The user or system that created this resource.
	CreatedBy *string

	// The date and time the resource ended running.
	EndedAt *time.Time

	// The job ID.
	JobId *string

	// The life cycle status.
	LifecycleStatus StepLifecycleStatus

	// The life cycle status message.
	LifecycleStatusMessage *string

	// The step name.
	Name *string

	// The parameters and combination expressions for the search.
	ParameterSpace *ParameterSpace

	// The queue ID.
	QueueId *string

	// The date and time the resource started running.
	StartedAt *time.Time

	// The step ID.
	StepId *string

	// The task status to start with on the job.
	TargetTaskRunStatus StepTargetTaskRunStatus

	// The total number of times tasks from the step failed and were retried.
	TaskFailureRetryCount *int32

	// The task run status for the job.
	//
	//   - PENDING –pending and waiting for resources.
	//
	//   - READY –ready to be processed.
	//
	//   - ASSIGNED –assigned and will run next on a worker.
	//
	//   - SCHEDULED –scheduled to be run on a worker.
	//
	//   - INTERRUPTING –being interrupted.
	//
	//   - RUNNING –running on a worker.
	//
	//   - SUSPENDED –the task is suspended.
	//
	//   - CANCELED –the task has been canceled.
	//
	//   - FAILED –the task has failed.
	//
	//   - SUCCEEDED –the task has succeeded.
	TaskRunStatus TaskRunStatus

	// The number of tasks running on the job.
	TaskRunStatusCounts map[string]int32

	// The date and time the resource was updated.
	UpdatedAt *time.Time

	// The user or system that updated this resource.
	UpdatedBy *string
	// contains filtered or unexported fields
}

The details of a step search.

type StepSummary 

type StepSummary struct {

	// The date and time the resource was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The user or system that created this resource.
	//
	// This member is required.
	CreatedBy *string

	// The life cycle status.
	//
	// This member is required.
	LifecycleStatus StepLifecycleStatus

	// The name of the step.
	//
	// This member is required.
	Name *string

	// The step ID.
	//
	// This member is required.
	StepId *string

	// The task run status for the job.
	//
	//   - PENDING –pending and waiting for resources.
	//
	//   - READY –ready to process.
	//
	//   - ASSIGNED –assigned and will run next on a worker.
	//
	//   - SCHEDULED –scheduled to run on a worker.
	//
	//   - INTERRUPTING –being interrupted.
	//
	//   - RUNNING –running on a worker.
	//
	//   - SUSPENDED –the task is suspended.
	//
	//   - CANCELED –the task has been canceled.
	//
	//   - FAILED –the task has failed.
	//
	//   - SUCCEEDED –the task has succeeded.
	//
	// This member is required.
	TaskRunStatus TaskRunStatus

	// The number of tasks running on the job.
	//
	// This member is required.
	TaskRunStatusCounts map[string]int32

	// The number of dependencies for the step.
	DependencyCounts *DependencyCounts

	// The date and time the resource ended running.
	EndedAt *time.Time

	// A message that describes the lifecycle of the step.
	LifecycleStatusMessage *string

	// The date and time the resource started running.
	StartedAt *time.Time

	// The task status to start with on the job.
	TargetTaskRunStatus StepTargetTaskRunStatus

	// The total number of times tasks from the step failed and were retried.
	TaskFailureRetryCount *int32

	// The date and time the resource was updated.
	UpdatedAt *time.Time

	// The user or system that updated this resource.
	UpdatedBy *string
	// contains filtered or unexported fields
}

The details for a step.

type StepTargetTaskRunStatus 

type StepTargetTaskRunStatus string
const (
	StepTargetTaskRunStatusReady     StepTargetTaskRunStatus = "READY"
	StepTargetTaskRunStatusFailed    StepTargetTaskRunStatus = "FAILED"
	StepTargetTaskRunStatusSucceeded StepTargetTaskRunStatus = "SUCCEEDED"
	StepTargetTaskRunStatusCanceled  StepTargetTaskRunStatus = "CANCELED"
	StepTargetTaskRunStatusSuspended StepTargetTaskRunStatus = "SUSPENDED"
	StepTargetTaskRunStatusPending   StepTargetTaskRunStatus = "PENDING"
)

Enum values for StepTargetTaskRunStatus

func (StepTargetTaskRunStatus) Values 

func (StepTargetTaskRunStatus) Values() []StepTargetTaskRunStatus

Values returns all known values for StepTargetTaskRunStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type StorageProfileOperatingSystemFamily 

type StorageProfileOperatingSystemFamily string
const (
	StorageProfileOperatingSystemFamilyWindows StorageProfileOperatingSystemFamily = "WINDOWS"
	StorageProfileOperatingSystemFamilyLinux   StorageProfileOperatingSystemFamily = "LINUX"
	StorageProfileOperatingSystemFamilyMacos   StorageProfileOperatingSystemFamily = "MACOS"
)

Enum values for StorageProfileOperatingSystemFamily

func (StorageProfileOperatingSystemFamily) Values 

func (StorageProfileOperatingSystemFamily) Values() []StorageProfileOperatingSystemFamily

Values returns all known values for StorageProfileOperatingSystemFamily. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type StorageProfileSummary 

type StorageProfileSummary struct {

	// The display name of the storage profile summary to update.
	//
	// 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.
	//
	// This member is required.
	DisplayName *string

	// The operating system (OS) family.
	//
	// This member is required.
	OsFamily StorageProfileOperatingSystemFamily

	// The storage profile ID.
	//
	// This member is required.
	StorageProfileId *string
	// contains filtered or unexported fields
}

The details of a storage profile.

type StringFilterExpression 

type StringFilterExpression struct {

	// The field name to search.
	//
	// This member is required.
	Name *string

	// The type of comparison to use for this search.
	//
	// This member is required.
	Operator ComparisonOperator

	// The string to search for.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

Searches for a particular string.

type SyncInputJobAttachmentsSessionActionDefinition 

type SyncInputJobAttachmentsSessionActionDefinition struct {

	// The step ID for the step in the job attachment.
	StepId *string
	// contains filtered or unexported fields
}

The job attachment in a session action to sync.

type SyncInputJobAttachmentsSessionActionDefinitionSummary 

type SyncInputJobAttachmentsSessionActionDefinitionSummary struct {

	// The step ID of the step in the job attachment.
	StepId *string
	// contains filtered or unexported fields
}

The details of a synced job attachment.

type TagPropagationMode added in v1.11.0 

type TagPropagationMode string
const (
	TagPropagationModeNoPropagation                  TagPropagationMode = "NO_PROPAGATION"
	TagPropagationModePropagateTagsToWorkersAtLaunch TagPropagationMode = "PROPAGATE_TAGS_TO_WORKERS_AT_LAUNCH"
)

Enum values for TagPropagationMode

func (TagPropagationMode) Values added in v1.11.0 

func (TagPropagationMode) Values() []TagPropagationMode

Values returns all known values for TagPropagationMode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type TaskParameterValue 

type TaskParameterValue interface {
	// contains filtered or unexported methods
}

The data types for the task parameters.

The following types satisfy this interface: 

TaskParameterValueMemberChunkInt
TaskParameterValueMemberFloat
TaskParameterValueMemberInt
TaskParameterValueMemberPath
TaskParameterValueMemberString
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/deadline/types"
)

func main() {
	var union types.TaskParameterValue
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.TaskParameterValueMemberChunkInt:
		_ = v.Value // Value is string

	case *types.TaskParameterValueMemberFloat:
		_ = v.Value // Value is string

	case *types.TaskParameterValueMemberInt:
		_ = v.Value // Value is string

	case *types.TaskParameterValueMemberPath:
		_ = v.Value // Value is string

	case *types.TaskParameterValueMemberString:
		_ = v.Value // Value is string

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type TaskParameterValueMemberChunkInt added in v1.15.0 

type TaskParameterValueMemberChunkInt struct {
	Value string
	// contains filtered or unexported fields
}

A range (for example 1-10) or selection of specific (for example 1,3,7,8,10) integers represented as a string.

type TaskParameterValueMemberFloat 

type TaskParameterValueMemberFloat struct {
	Value string
	// contains filtered or unexported fields
}

A double precision IEEE-754 floating point number represented as a string.

type TaskParameterValueMemberInt 

type TaskParameterValueMemberInt struct {
	Value string
	// contains filtered or unexported fields
}

A signed integer represented as a string.

type TaskParameterValueMemberPath 

type TaskParameterValueMemberPath struct {
	Value string
	// contains filtered or unexported fields
}

A file system path represented as a string.

type TaskParameterValueMemberString 

type TaskParameterValueMemberString struct {
	Value string
	// contains filtered or unexported fields
}

A UTF-8 string.

type TaskRunManifestPropertiesRequest added in v1.15.0 

type TaskRunManifestPropertiesRequest struct {

	// The hash value of the file.
	OutputManifestHash *string

	// The manifest file path.
	OutputManifestPath *string
	// contains filtered or unexported fields
}

The output manifest properties reported by the worker agent for a completed task run.

type TaskRunManifestPropertiesResponse added in v1.15.0 

type TaskRunManifestPropertiesResponse struct {

	// The hash value of the file.
	OutputManifestHash *string

	// The manifest file path.
	OutputManifestPath *string
	// contains filtered or unexported fields
}

The manifest properties for a task run, corresponding to the manifest properties in the job.

type TaskRunSessionActionDefinition 

type TaskRunSessionActionDefinition struct {

	// The task parameters.
	//
	// This member is required.
	Parameters map[string]TaskParameterValue

	// The step ID.
	//
	// This member is required.
	StepId *string

	// The task ID.
	TaskId *string
	// contains filtered or unexported fields
}

The task, step, and parameters for the task run in the session action.

type TaskRunSessionActionDefinitionSummary 

type TaskRunSessionActionDefinitionSummary struct {

	// The step ID.
	//
	// This member is required.
	StepId *string

	// The parameters of a task run in a session action.
	Parameters map[string]TaskParameterValue

	// The task ID.
	TaskId *string
	// contains filtered or unexported fields
}

The details of a task run in a session action.

type TaskRunStatus 

type TaskRunStatus string
const (
	TaskRunStatusPending       TaskRunStatus = "PENDING"
	TaskRunStatusReady         TaskRunStatus = "READY"
	TaskRunStatusAssigned      TaskRunStatus = "ASSIGNED"
	TaskRunStatusStarting      TaskRunStatus = "STARTING"
	TaskRunStatusScheduled     TaskRunStatus = "SCHEDULED"
	TaskRunStatusInterrupting  TaskRunStatus = "INTERRUPTING"
	TaskRunStatusRunning       TaskRunStatus = "RUNNING"
	TaskRunStatusSuspended     TaskRunStatus = "SUSPENDED"
	TaskRunStatusCanceled      TaskRunStatus = "CANCELED"
	TaskRunStatusFailed        TaskRunStatus = "FAILED"
	TaskRunStatusSucceeded     TaskRunStatus = "SUCCEEDED"
	TaskRunStatusNotCompatible TaskRunStatus = "NOT_COMPATIBLE"
)

Enum values for TaskRunStatus

func (TaskRunStatus) Values 

func (TaskRunStatus) Values() []TaskRunStatus

Values returns all known values for TaskRunStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type TaskSearchSummary 

type TaskSearchSummary struct {

	// The date and time the resource ended running.
	EndedAt *time.Time

	// The number of times that the task failed and was retried.
	FailureRetryCount *int32

	// The job ID.
	JobId *string

	// The parameters to search for.
	Parameters map[string]TaskParameterValue

	// The queue ID.
	QueueId *string

	// The run status of the task.
	RunStatus TaskRunStatus

	// The date and time the resource started running.
	StartedAt *time.Time

	// The step ID.
	StepId *string

	// The run status that the task is being updated to.
	TargetRunStatus TaskTargetRunStatus

	// The task ID.
	TaskId *string

	// The date and time the resource was updated.
	UpdatedAt *time.Time

	// The user or system that updated this resource.
	UpdatedBy *string
	// contains filtered or unexported fields
}

The details of a task search.

type TaskSummary 

type TaskSummary struct {

	// The date and time the resource was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The user or system that created this resource.
	//
	// This member is required.
	CreatedBy *string

	// The run status of the task.
	//
	// This member is required.
	RunStatus TaskRunStatus

	// The task ID.
	//
	// This member is required.
	TaskId *string

	// The date and time the resource ended running.
	EndedAt *time.Time

	// The number of times that the task failed and was retried.
	FailureRetryCount *int32

	// The latest session action for the task.
	LatestSessionActionId *string

	// The task parameters.
	Parameters map[string]TaskParameterValue

	// The date and time the resource started running.
	StartedAt *time.Time

	// The run status on which the started.
	TargetRunStatus TaskTargetRunStatus

	// The date and time the resource was updated.
	UpdatedAt *time.Time

	// The user or system that updated this resource.
	UpdatedBy *string
	// contains filtered or unexported fields
}

The details of a task.

type TaskTargetRunStatus 

type TaskTargetRunStatus string
const (
	TaskTargetRunStatusReady     TaskTargetRunStatus = "READY"
	TaskTargetRunStatusFailed    TaskTargetRunStatus = "FAILED"
	TaskTargetRunStatusSucceeded TaskTargetRunStatus = "SUCCEEDED"
	TaskTargetRunStatusCanceled  TaskTargetRunStatus = "CANCELED"
	TaskTargetRunStatusSuspended TaskTargetRunStatus = "SUSPENDED"
	TaskTargetRunStatusPending   TaskTargetRunStatus = "PENDING"
)

Enum values for TaskTargetRunStatus

func (TaskTargetRunStatus) Values 

func (TaskTargetRunStatus) Values() []TaskTargetRunStatus

Values returns all known values for TaskTargetRunStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ThrottlingException 

type ThrottlingException struct {
	Message *string

	ErrorCodeOverride *string

	ServiceCode       *string
	QuotaCode         *string
	RetryAfterSeconds *int32
	Context           map[string]string
	// contains filtered or unexported fields
}

Your request exceeded a request rate quota.

func (*ThrottlingException) Error 

func (e *ThrottlingException) Error() string

func (*ThrottlingException) ErrorCode 

func (e *ThrottlingException) ErrorCode() string

func (*ThrottlingException) ErrorFault 

func (e *ThrottlingException) ErrorFault() smithy.ErrorFault

func (*ThrottlingException) ErrorMessage 

func (e *ThrottlingException) ErrorMessage() string

type UnknownUnionMember 

type UnknownUnionMember struct {
	Tag   string
	Value []byte
	// contains filtered or unexported fields
}

UnknownUnionMember is returned when a union member is returned over the wire, but has an unknown tag.

type UpdateJobLifecycleStatus 

type UpdateJobLifecycleStatus string
const (
	UpdateJobLifecycleStatusArchived UpdateJobLifecycleStatus = "ARCHIVED"
)

Enum values for UpdateJobLifecycleStatus

func (UpdateJobLifecycleStatus) Values 

func (UpdateJobLifecycleStatus) Values() []UpdateJobLifecycleStatus

Values returns all known values for UpdateJobLifecycleStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type UpdateQueueFleetAssociationStatus 

type UpdateQueueFleetAssociationStatus string
const (
	UpdateQueueFleetAssociationStatusActive                         UpdateQueueFleetAssociationStatus = "ACTIVE"
	UpdateQueueFleetAssociationStatusStopSchedulingAndCompleteTasks UpdateQueueFleetAssociationStatus = "STOP_SCHEDULING_AND_COMPLETE_TASKS"
	UpdateQueueFleetAssociationStatusStopSchedulingAndCancelTasks   UpdateQueueFleetAssociationStatus = "STOP_SCHEDULING_AND_CANCEL_TASKS"
)

Enum values for UpdateQueueFleetAssociationStatus

func (UpdateQueueFleetAssociationStatus) Values 

func (UpdateQueueFleetAssociationStatus) Values() []UpdateQueueFleetAssociationStatus

Values returns all known values for UpdateQueueFleetAssociationStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type UpdateQueueLimitAssociationStatus added in v1.8.0 

type UpdateQueueLimitAssociationStatus string
const (
	UpdateQueueLimitAssociationStatusActive                         UpdateQueueLimitAssociationStatus = "ACTIVE"
	UpdateQueueLimitAssociationStatusStopLimitUsageAndCompleteTasks UpdateQueueLimitAssociationStatus = "STOP_LIMIT_USAGE_AND_COMPLETE_TASKS"
	UpdateQueueLimitAssociationStatusStopLimitUsageAndCancelTasks   UpdateQueueLimitAssociationStatus = "STOP_LIMIT_USAGE_AND_CANCEL_TASKS"
)

Enum values for UpdateQueueLimitAssociationStatus

func (UpdateQueueLimitAssociationStatus) Values added in v1.8.0 

func (UpdateQueueLimitAssociationStatus) Values() []UpdateQueueLimitAssociationStatus

Values returns all known values for UpdateQueueLimitAssociationStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type UpdatedSessionActionInfo 

type UpdatedSessionActionInfo struct {

	// The status of the session upon completion.
	CompletedStatus CompletedStatus

	// The date and time the resource ended running.
	EndedAt *time.Time

	// A list of output manifest properties reported by the worker agent, with each
	// entry corresponding to a manifest property in the job.
	Manifests []TaskRunManifestPropertiesRequest

	// The process exit code. The default Deadline Cloud worker agent converts
	// unsigned 32-bit exit codes to signed 32-bit exit codes.
	ProcessExitCode *int32

	// A message to indicate the progress of the updated session action.
	ProgressMessage *string

	// The percentage completed.
	ProgressPercent *float32

	// The date and time the resource started running.
	StartedAt *time.Time

	// The updated time.
	UpdatedAt *time.Time
	// contains filtered or unexported fields
}

The updated session action information as it relates to completion and progress of the session.

type UpdatedWorkerStatus 

type UpdatedWorkerStatus string
const (
	UpdatedWorkerStatusStarted  UpdatedWorkerStatus = "STARTED"
	UpdatedWorkerStatusStopping UpdatedWorkerStatus = "STOPPING"
	UpdatedWorkerStatusStopped  UpdatedWorkerStatus = "STOPPED"
)

Enum values for UpdatedWorkerStatus

func (UpdatedWorkerStatus) Values 

func (UpdatedWorkerStatus) Values() []UpdatedWorkerStatus

Values returns all known values for UpdatedWorkerStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type UsageGroupByField 

type UsageGroupByField string
const (
	UsageGroupByFieldQueueId        UsageGroupByField = "QUEUE_ID"
	UsageGroupByFieldFleetId        UsageGroupByField = "FLEET_ID"
	UsageGroupByFieldJobId          UsageGroupByField = "JOB_ID"
	UsageGroupByFieldUserId         UsageGroupByField = "USER_ID"
	UsageGroupByFieldUsageType      UsageGroupByField = "USAGE_TYPE"
	UsageGroupByFieldInstanceType   UsageGroupByField = "INSTANCE_TYPE"
	UsageGroupByFieldLicenseProduct UsageGroupByField = "LICENSE_PRODUCT"
)

Enum values for UsageGroupByField

func (UsageGroupByField) Values 

func (UsageGroupByField) Values() []UsageGroupByField

Values returns all known values for UsageGroupByField. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type UsageStatistic 

type UsageStatistic string
const (
	UsageStatisticSum UsageStatistic = "SUM"
	UsageStatisticMin UsageStatistic = "MIN"
	UsageStatisticMax UsageStatistic = "MAX"
	UsageStatisticAvg UsageStatistic = "AVG"
)

Enum values for UsageStatistic

func (UsageStatistic) Values 

func (UsageStatistic) Values() []UsageStatistic

Values returns all known values for UsageStatistic. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type UsageTrackingResource 

type UsageTrackingResource interface {
	// contains filtered or unexported methods
}

The usage details of the allotted budget.

The following types satisfy this interface: 

UsageTrackingResourceMemberQueueId
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/deadline/types"
)

func main() {
	var union types.UsageTrackingResource
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.UsageTrackingResourceMemberQueueId:
		_ = v.Value // Value is string

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type UsageTrackingResourceMemberQueueId 

type UsageTrackingResourceMemberQueueId struct {
	Value string
	// contains filtered or unexported fields
}

The queue ID.

type UsageType 

type UsageType string
const (
	UsageTypeCompute UsageType = "COMPUTE"
	UsageTypeLicense UsageType = "LICENSE"
)

Enum values for UsageType

func (UsageType) Values 

func (UsageType) Values() []UsageType

Values returns all known values for UsageType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type UserJobsFirst 

type UserJobsFirst struct {

	// The user's ID.
	//
	// This member is required.
	UserIdentityId *string
	// contains filtered or unexported fields
}

Allows setting a specific user's job to run first.

type VCpuCountRange 

type VCpuCountRange struct {

	// The minimum amount of vCPU.
	//
	// This member is required.
	Min *int32

	// The maximum amount of vCPU.
	Max *int32
	// contains filtered or unexported fields
}

The allowable range of vCPU processing power for the fleet.

type ValidationException 

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string

	Reason    ValidationExceptionReason
	FieldList []ValidationExceptionField
	Context   map[string]string
	// contains filtered or unexported fields
}

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

func (*ValidationException) Error 

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode 

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault 

func (e *ValidationException) ErrorFault() smithy.ErrorFault

func (*ValidationException) ErrorMessage 

func (e *ValidationException) ErrorMessage() string

type ValidationExceptionField 

type ValidationExceptionField struct {

	// The error message for the validation exception.
	//
	// This member is required.
	Message *string

	// The name of the validation exception.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

The details of a validation exception.

type ValidationExceptionReason 

type ValidationExceptionReason string
const (
	ValidationExceptionReasonUnknownOperation      ValidationExceptionReason = "UNKNOWN_OPERATION"
	ValidationExceptionReasonCannotParse           ValidationExceptionReason = "CANNOT_PARSE"
	ValidationExceptionReasonFieldValidationFailed ValidationExceptionReason = "FIELD_VALIDATION_FAILED"
	ValidationExceptionReasonOther                 ValidationExceptionReason = "OTHER"
)

Enum values for ValidationExceptionReason

func (ValidationExceptionReason) Values 

func (ValidationExceptionReason) Values() []ValidationExceptionReason

Values returns all known values for ValidationExceptionReason. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type VpcConfiguration added in v1.16.0 

type VpcConfiguration struct {

	// The ARNs of the VPC Lattice resource configurations attached to the fleet.
	ResourceConfigurationArns []string
	// contains filtered or unexported fields
}

The configuration options for a service managed fleet's VPC.

type WindowsUser 

type WindowsUser struct {

	// The password ARN for the Windows user.
	//
	// This member is required.
	PasswordArn *string

	// The user.
	//
	// This member is required.
	User *string
	// contains filtered or unexported fields
}

The Windows user details.

type WorkerAmountCapability 

type WorkerAmountCapability struct {

	// The name of the worker amount capability.
	//
	// This member is required.
	Name *string

	// The value of the worker amount capability.
	//
	// This member is required.
	Value *float32
	// contains filtered or unexported fields
}

The details of the worker amount capability.

type WorkerAttributeCapability 

type WorkerAttributeCapability struct {

	// The name of the worker attribute capability.
	//
	// This member is required.
	Name *string

	// The values of the worker amount capability.
	//
	// This member is required.
	Values []string
	// contains filtered or unexported fields
}

The details of the worker attribute capability.

type WorkerCapabilities 

type WorkerCapabilities struct {

	// The worker capabilities amounts on a list of worker capabilities.
	//
	// This member is required.
	Amounts []WorkerAmountCapability

	// The worker attribute capabilities in the list of attribute capabilities.
	//
	// This member is required.
	Attributes []WorkerAttributeCapability
	// contains filtered or unexported fields
}

The details for worker capabilities.

type WorkerSearchSummary 

type WorkerSearchSummary struct {

	// The date and time the resource was created.
	CreatedAt *time.Time

	// The user or system that created this resource.
	CreatedBy *string

	// The fleet ID.
	FleetId *string

	// Provides the Amazon EC2 instance properties of the worker host.
	HostProperties *HostPropertiesResponse

	// The status of the worker search.
	Status WorkerStatus

	// The date and time the resource was updated.
	UpdatedAt *time.Time

	// The user or system that updated this resource.
	UpdatedBy *string

	// The worker ID.
	WorkerId *string
	// contains filtered or unexported fields
}

The details of a worker search.

type WorkerSessionSummary 

type WorkerSessionSummary struct {

	// The job ID for the job associated with the worker's session.
	//
	// This member is required.
	JobId *string

	// The life cycle status for the worker's session.
	//
	// This member is required.
	LifecycleStatus SessionLifecycleStatus

	// The queue ID for the queue associated to the worker.
	//
	// This member is required.
	QueueId *string

	// The session ID for the session action.
	//
	// This member is required.
	SessionId *string

	// The date and time the resource started running.
	//
	// This member is required.
	StartedAt *time.Time

	// The date and time the resource ended running.
	EndedAt *time.Time

	// The life cycle status
	TargetLifecycleStatus SessionLifecycleTargetStatus
	// contains filtered or unexported fields
}

Summarizes the session for a particular worker.

type WorkerStatus 

type WorkerStatus string
const (
	WorkerStatusCreated       WorkerStatus = "CREATED"
	WorkerStatusStarted       WorkerStatus = "STARTED"
	WorkerStatusStopping      WorkerStatus = "STOPPING"
	WorkerStatusStopped       WorkerStatus = "STOPPED"
	WorkerStatusNotResponding WorkerStatus = "NOT_RESPONDING"
	WorkerStatusNotCompatible WorkerStatus = "NOT_COMPATIBLE"
	WorkerStatusRunning       WorkerStatus = "RUNNING"
	WorkerStatusIdle          WorkerStatus = "IDLE"
)

Enum values for WorkerStatus

func (WorkerStatus) Values 

func (WorkerStatus) Values() []WorkerStatus

Values returns all known values for WorkerStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type WorkerSummary 

type WorkerSummary struct {

	// The date and time the resource was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The user or system that created this resource.
	//
	// This member is required.
	CreatedBy *string

	// The farm ID.
	//
	// This member is required.
	FarmId *string

	// The fleet ID.
	//
	// This member is required.
	FleetId *string

	// The status of the worker.
	//
	// This member is required.
	Status WorkerStatus

	// The worker ID.
	//
	// This member is required.
	WorkerId *string

	// The host properties of the worker.
	HostProperties *HostPropertiesResponse

	// The log configuration for the worker.
	Log *LogConfiguration

	// The date and time the resource was updated.
	UpdatedAt *time.Time

	// The user or system that updated this resource.
	UpdatedBy *string
	// contains filtered or unexported fields
}

The summary of details for a worker.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.