deadline

package module
v1.7.1 Latest Latest
Warning

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

 Go to latest Published: Nov 18, 2024 License: Apache-2.0 Imports: 50 Imported by: 5

Documentation

Overview

Package deadline provides the API client, operations, and parameter types for AWSDeadlineCloud.

The Amazon Web Services Deadline Cloud API provides infrastructure and centralized management for your projects. Use the Deadline Cloud API to onboard users, assign projects, and attach permissions specific to their job function.

With Deadline Cloud, content production teams can deploy resources for their workforce securely in the cloud, reducing the costs of added physical infrastructure. Keep your content production operations secure, while allowing your contributors to access the tools they need, such as scalable high-speed storage, licenses, and cost management services.

Index

Constants

View Source 
const ServiceAPIVersion = "2023-10-12"
View Source 
const ServiceID = "deadline"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.

To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName 

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion 

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AssociateMemberToFarmInput 

type AssociateMemberToFarmInput struct {

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

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

	// The principal's membership level for the associated farm.
	//
	// This member is required.
	MembershipLevel types.MembershipLevel

	// The member's principal ID to associate with the farm.
	//
	// This member is required.
	PrincipalId *string

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

type AssociateMemberToFarmOutput 

type AssociateMemberToFarmOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type AssociateMemberToFleetInput 

type AssociateMemberToFleetInput struct {

	// The farm ID of the fleet to associate with the member.
	//
	// This member is required.
	FarmId *string

	// The ID of the fleet to associate with a member.
	//
	// This member is required.
	FleetId *string

	// The member's identity store ID to associate with the fleet.
	//
	// This member is required.
	IdentityStoreId *string

	// The principal's membership level for the associated fleet.
	//
	// This member is required.
	MembershipLevel types.MembershipLevel

	// The member's principal ID to associate with a fleet.
	//
	// This member is required.
	PrincipalId *string

	// The member's principal type to associate with the fleet.
	//
	// This member is required.
	PrincipalType types.DeadlinePrincipalType
	// contains filtered or unexported fields
}

type AssociateMemberToFleetOutput 

type AssociateMemberToFleetOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type AssociateMemberToJobInput 

type AssociateMemberToJobInput struct {

	// The farm ID of the job to associate with the member.
	//
	// This member is required.
	FarmId *string

	// The member's identity store ID to associate with the job.
	//
	// This member is required.
	IdentityStoreId *string

	// The job ID to associate with the member.
	//
	// This member is required.
	JobId *string

	// The principal's membership level for the associated job.
	//
	// This member is required.
	MembershipLevel types.MembershipLevel

	// The member's principal ID to associate with the job.
	//
	// This member is required.
	PrincipalId *string

	// The member's principal type to associate with the job.
	//
	// This member is required.
	PrincipalType types.DeadlinePrincipalType

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

type AssociateMemberToJobOutput 

type AssociateMemberToJobOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type AssociateMemberToQueueInput 

type AssociateMemberToQueueInput struct {

	// The farm ID of the queue to associate with the member.
	//
	// This member is required.
	FarmId *string

	// The member's identity store ID to associate with the queue.
	//
	// This member is required.
	IdentityStoreId *string

	// The principal's membership level for the associated queue.
	//
	// This member is required.
	MembershipLevel types.MembershipLevel

	// The member's principal ID to associate with the queue.
	//
	// This member is required.
	PrincipalId *string

	// The member's principal type to associate with the queue.
	//
	// This member is required.
	PrincipalType types.DeadlinePrincipalType

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

type AssociateMemberToQueueOutput 

type AssociateMemberToQueueOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type AssumeFleetRoleForReadInput 

type AssumeFleetRoleForReadInput struct {

	// The farm ID for the fleet's farm.
	//
	// This member is required.
	FarmId *string

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

type AssumeFleetRoleForReadOutput 

type AssumeFleetRoleForReadOutput struct {

	// The credentials for the fleet role.
	//
	// This member is required.
	Credentials *types.AwsCredentials

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type AssumeFleetRoleForWorkerInput 

type AssumeFleetRoleForWorkerInput struct {

	// The farm ID for the fleet's farm.
	//
	// This member is required.
	FarmId *string

	// The fleet ID that contains the worker.
	//
	// This member is required.
	FleetId *string

	// The ID of the worker assuming the fleet role.
	//
	// This member is required.
	WorkerId *string
	// contains filtered or unexported fields
}

type AssumeFleetRoleForWorkerOutput 

type AssumeFleetRoleForWorkerOutput struct {

	// The credentials for the worker.
	//
	// This member is required.
	Credentials *types.AwsCredentials

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type AssumeQueueRoleForReadInput 

type AssumeQueueRoleForReadInput struct {

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

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

type AssumeQueueRoleForReadOutput 

type AssumeQueueRoleForReadOutput struct {

	// The credentials for the queue role.
	//
	// This member is required.
	Credentials *types.AwsCredentials

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type AssumeQueueRoleForUserInput 

type AssumeQueueRoleForUserInput struct {

	// The farm ID of the queue that the user assumes the role for.
	//
	// This member is required.
	FarmId *string

	// The queue ID of the queue that the user assumes the role for.
	//
	// This member is required.
	QueueId *string
	// contains filtered or unexported fields
}

type AssumeQueueRoleForUserOutput 

type AssumeQueueRoleForUserOutput struct {

	// The credentials for the queue role that a user has access to.
	//
	// This member is required.
	Credentials *types.AwsCredentials

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type AssumeQueueRoleForWorkerInput 

type AssumeQueueRoleForWorkerInput struct {

	// The farm ID of the worker assuming the queue role.
	//
	// This member is required.
	FarmId *string

	// The fleet ID of the worker assuming the queue role.
	//
	// This member is required.
	FleetId *string

	// The queue ID of the worker assuming the queue role.
	//
	// This member is required.
	QueueId *string

	// The worker ID of the worker assuming the queue role.
	//
	// This member is required.
	WorkerId *string
	// contains filtered or unexported fields
}

type AssumeQueueRoleForWorkerOutput 

type AssumeQueueRoleForWorkerOutput struct {

	// The Amazon Web Services credentials for the role that the worker is assuming.
	Credentials *types.AwsCredentials

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type AuthResolverParameters 

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver 

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type BatchGetJobEntityInput 

type BatchGetJobEntityInput struct {

	// The farm ID of the worker that's fetching job details. The worker must have an
	// assignment on a job to fetch job details.
	//
	// This member is required.
	FarmId *string

	// The fleet ID of the worker that's fetching job details. The worker must have an
	// assignment on a job to fetch job details.
	//
	// This member is required.
	FleetId *string

	// The job identifiers to include within the job entity batch details.
	//
	// This member is required.
	Identifiers []types.JobEntityIdentifiersUnion

	// The worker ID of the worker containing the job details to get.
	//
	// This member is required.
	WorkerId *string
	// contains filtered or unexported fields
}

type BatchGetJobEntityOutput 

type BatchGetJobEntityOutput struct {

	// A list of the job entities, or details, in the batch.
	//
	// This member is required.
	Entities []types.JobEntity

	// A list of errors from the job error logs for the batch.
	//
	// This member is required.
	Errors []types.GetJobEntityError

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client provides the API client to make operations call for AWSDeadlineCloud.

func New 

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) AssociateMemberToFarm 

func (c *Client) AssociateMemberToFarm(ctx context.Context, params *AssociateMemberToFarmInput, optFns ...func(*Options)) (*AssociateMemberToFarmOutput, error)

Assigns a farm membership level to a member.

func (*Client) AssociateMemberToFleet 

func (c *Client) AssociateMemberToFleet(ctx context.Context, params *AssociateMemberToFleetInput, optFns ...func(*Options)) (*AssociateMemberToFleetOutput, error)

Assigns a fleet membership level to a member.

func (*Client) AssociateMemberToJob 

func (c *Client) AssociateMemberToJob(ctx context.Context, params *AssociateMemberToJobInput, optFns ...func(*Options)) (*AssociateMemberToJobOutput, error)

Assigns a job membership level to a member

func (*Client) AssociateMemberToQueue 

func (c *Client) AssociateMemberToQueue(ctx context.Context, params *AssociateMemberToQueueInput, optFns ...func(*Options)) (*AssociateMemberToQueueOutput, error)

Assigns a queue membership level to a member

func (*Client) AssumeFleetRoleForRead 

func (c *Client) AssumeFleetRoleForRead(ctx context.Context, params *AssumeFleetRoleForReadInput, optFns ...func(*Options)) (*AssumeFleetRoleForReadOutput, error)

Get Amazon Web Services credentials from the fleet role. The IAM permissions of the credentials are scoped down to have read-only access.

func (*Client) AssumeFleetRoleForWorker 

func (c *Client) AssumeFleetRoleForWorker(ctx context.Context, params *AssumeFleetRoleForWorkerInput, optFns ...func(*Options)) (*AssumeFleetRoleForWorkerOutput, error)

Get credentials from the fleet role for a worker.

func (*Client) AssumeQueueRoleForRead 

func (c *Client) AssumeQueueRoleForRead(ctx context.Context, params *AssumeQueueRoleForReadInput, optFns ...func(*Options)) (*AssumeQueueRoleForReadOutput, error)

Gets Amazon Web Services credentials from the queue role. The IAM permissions of the credentials are scoped down to have read-only access.

func (*Client) AssumeQueueRoleForUser 

func (c *Client) AssumeQueueRoleForUser(ctx context.Context, params *AssumeQueueRoleForUserInput, optFns ...func(*Options)) (*AssumeQueueRoleForUserOutput, error)

Allows a user to assume a role for a queue.

func (*Client) AssumeQueueRoleForWorker 

func (c *Client) AssumeQueueRoleForWorker(ctx context.Context, params *AssumeQueueRoleForWorkerInput, optFns ...func(*Options)) (*AssumeQueueRoleForWorkerOutput, error)

Allows a worker to assume a queue role.

func (*Client) BatchGetJobEntity 

func (c *Client) BatchGetJobEntity(ctx context.Context, params *BatchGetJobEntityInput, optFns ...func(*Options)) (*BatchGetJobEntityOutput, error)

Get batched job details for a worker.

func (*Client) CopyJobTemplate 

func (c *Client) CopyJobTemplate(ctx context.Context, params *CopyJobTemplateInput, optFns ...func(*Options)) (*CopyJobTemplateOutput, error)

Copies a job template to an Amazon S3 bucket.

func (*Client) CreateBudget 

func (c *Client) CreateBudget(ctx context.Context, params *CreateBudgetInput, optFns ...func(*Options)) (*CreateBudgetOutput, error)

Creates a budget to set spending thresholds for your rendering activity.

func (*Client) CreateFarm 

func (c *Client) CreateFarm(ctx context.Context, params *CreateFarmInput, optFns ...func(*Options)) (*CreateFarmOutput, error)

Creates a farm to allow space for queues and fleets. Farms are the space where the components of your renders gather and are pieced together in the cloud. Farms contain budgets and allow you to enforce permissions. Deadline Cloud farms are a useful container for large projects.

func (*Client) CreateFleet 

func (c *Client) CreateFleet(ctx context.Context, params *CreateFleetInput, optFns ...func(*Options)) (*CreateFleetOutput, error)

Creates a fleet. Fleets gather information relating to compute, or capacity, for renders within your farms. You can choose to manage your own capacity or opt to have fleets fully managed by Deadline Cloud.

func (*Client) CreateJob 

func (c *Client) CreateJob(ctx context.Context, params *CreateJobInput, optFns ...func(*Options)) (*CreateJobOutput, error)

Creates a job. A job is a set of instructions that AWS Deadline Cloud uses to schedule and run work on available workers. For more information, see Deadline Cloud jobs.

func (*Client) CreateLicenseEndpoint 

func (c *Client) CreateLicenseEndpoint(ctx context.Context, params *CreateLicenseEndpointInput, optFns ...func(*Options)) (*CreateLicenseEndpointOutput, error)

Creates a license endpoint to integrate your various licensed software used for rendering on Deadline Cloud.

func (*Client) CreateMonitor 

func (c *Client) CreateMonitor(ctx context.Context, params *CreateMonitorInput, optFns ...func(*Options)) (*CreateMonitorOutput, error)

Creates an Amazon Web Services Deadline Cloud monitor that you can use to view your farms, queues, and fleets. After you submit a job, you can track the progress of the tasks and steps that make up the job, and then download the job's results.

func (*Client) CreateQueue 

func (c *Client) CreateQueue(ctx context.Context, params *CreateQueueInput, optFns ...func(*Options)) (*CreateQueueOutput, error)

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

func (*Client) CreateQueueEnvironment 

func (c *Client) CreateQueueEnvironment(ctx context.Context, params *CreateQueueEnvironmentInput, optFns ...func(*Options)) (*CreateQueueEnvironmentOutput, error)

Creates an environment for a queue that defines how jobs in the queue run.

func (*Client) CreateQueueFleetAssociation 

func (c *Client) CreateQueueFleetAssociation(ctx context.Context, params *CreateQueueFleetAssociationInput, optFns ...func(*Options)) (*CreateQueueFleetAssociationOutput, error)

Creates an association between a queue and a fleet.

func (*Client) CreateStorageProfile 

func (c *Client) CreateStorageProfile(ctx context.Context, params *CreateStorageProfileInput, optFns ...func(*Options)) (*CreateStorageProfileOutput, error)

Creates a storage profile that specifies the operating system, file type, and file location of resources used on a farm.

func (*Client) CreateWorker 

func (c *Client) CreateWorker(ctx context.Context, params *CreateWorkerInput, optFns ...func(*Options)) (*CreateWorkerOutput, error)

Creates a worker. A worker tells your instance how much processing power (vCPU), and memory (GiB) you’ll need to assemble the digital assets held within a particular instance. You can specify certain instance types to use, or let the worker know which instances types to exclude.

func (*Client) DeleteBudget 

func (c *Client) DeleteBudget(ctx context.Context, params *DeleteBudgetInput, optFns ...func(*Options)) (*DeleteBudgetOutput, error)

Deletes a budget.

func (*Client) DeleteFarm 

func (c *Client) DeleteFarm(ctx context.Context, params *DeleteFarmInput, optFns ...func(*Options)) (*DeleteFarmOutput, error)

Deletes a farm.

func (*Client) DeleteFleet 

func (c *Client) DeleteFleet(ctx context.Context, params *DeleteFleetInput, optFns ...func(*Options)) (*DeleteFleetOutput, error)

Deletes a fleet.

func (*Client) DeleteLicenseEndpoint 

func (c *Client) DeleteLicenseEndpoint(ctx context.Context, params *DeleteLicenseEndpointInput, optFns ...func(*Options)) (*DeleteLicenseEndpointOutput, error)

Deletes a license endpoint.

func (*Client) DeleteMeteredProduct 

func (c *Client) DeleteMeteredProduct(ctx context.Context, params *DeleteMeteredProductInput, optFns ...func(*Options)) (*DeleteMeteredProductOutput, error)

Deletes a metered product.

func (*Client) DeleteMonitor 

func (c *Client) DeleteMonitor(ctx context.Context, params *DeleteMonitorInput, optFns ...func(*Options)) (*DeleteMonitorOutput, error)

Removes a Deadline Cloud monitor. After you delete a monitor, you can create a new one and attach farms to the monitor.

func (*Client) DeleteQueue 

func (c *Client) DeleteQueue(ctx context.Context, params *DeleteQueueInput, optFns ...func(*Options)) (*DeleteQueueOutput, error)

Deletes a queue.

You can't recover the jobs in a queue if you delete the queue. Deleting the queue also deletes the jobs in that queue.

func (*Client) DeleteQueueEnvironment 

func (c *Client) DeleteQueueEnvironment(ctx context.Context, params *DeleteQueueEnvironmentInput, optFns ...func(*Options)) (*DeleteQueueEnvironmentOutput, error)

Deletes a queue environment.

func (*Client) DeleteQueueFleetAssociation 

func (c *Client) DeleteQueueFleetAssociation(ctx context.Context, params *DeleteQueueFleetAssociationInput, optFns ...func(*Options)) (*DeleteQueueFleetAssociationOutput, error)

Deletes a queue-fleet association.

func (*Client) DeleteStorageProfile 

func (c *Client) DeleteStorageProfile(ctx context.Context, params *DeleteStorageProfileInput, optFns ...func(*Options)) (*DeleteStorageProfileOutput, error)

Deletes a storage profile.

func (*Client) DeleteWorker 

func (c *Client) DeleteWorker(ctx context.Context, params *DeleteWorkerInput, optFns ...func(*Options)) (*DeleteWorkerOutput, error)

Deletes a worker.

func (*Client) DisassociateMemberFromFarm 

func (c *Client) DisassociateMemberFromFarm(ctx context.Context, params *DisassociateMemberFromFarmInput, optFns ...func(*Options)) (*DisassociateMemberFromFarmOutput, error)

Disassociates a member from a farm.

func (*Client) DisassociateMemberFromFleet 

func (c *Client) DisassociateMemberFromFleet(ctx context.Context, params *DisassociateMemberFromFleetInput, optFns ...func(*Options)) (*DisassociateMemberFromFleetOutput, error)

Disassociates a member from a fleet.

func (*Client) DisassociateMemberFromJob 

func (c *Client) DisassociateMemberFromJob(ctx context.Context, params *DisassociateMemberFromJobInput, optFns ...func(*Options)) (*DisassociateMemberFromJobOutput, error)

Disassociates a member from a job.

func (*Client) DisassociateMemberFromQueue 

func (c *Client) DisassociateMemberFromQueue(ctx context.Context, params *DisassociateMemberFromQueueInput, optFns ...func(*Options)) (*DisassociateMemberFromQueueOutput, error)

Disassociates a member from a queue.

func (*Client) GetBudget 

func (c *Client) GetBudget(ctx context.Context, params *GetBudgetInput, optFns ...func(*Options)) (*GetBudgetOutput, error)

Get a budget.

func (*Client) GetFarm 

func (c *Client) GetFarm(ctx context.Context, params *GetFarmInput, optFns ...func(*Options)) (*GetFarmOutput, error)

Get a farm.

func (*Client) GetFleet 

func (c *Client) GetFleet(ctx context.Context, params *GetFleetInput, optFns ...func(*Options)) (*GetFleetOutput, error)

Get a fleet.

func (*Client) GetJob 

func (c *Client) GetJob(ctx context.Context, params *GetJobInput, optFns ...func(*Options)) (*GetJobOutput, error)

Gets a Deadline Cloud job.

func (*Client) GetLicenseEndpoint 

func (c *Client) GetLicenseEndpoint(ctx context.Context, params *GetLicenseEndpointInput, optFns ...func(*Options)) (*GetLicenseEndpointOutput, error)

Gets a licence endpoint.

func (*Client) GetMonitor 

func (c *Client) GetMonitor(ctx context.Context, params *GetMonitorInput, optFns ...func(*Options)) (*GetMonitorOutput, error)

Gets information about the specified monitor.

func (*Client) GetQueue 

func (c *Client) GetQueue(ctx context.Context, params *GetQueueInput, optFns ...func(*Options)) (*GetQueueOutput, error)

Gets a queue.

func (*Client) GetQueueEnvironment 

func (c *Client) GetQueueEnvironment(ctx context.Context, params *GetQueueEnvironmentInput, optFns ...func(*Options)) (*GetQueueEnvironmentOutput, error)

Gets a queue environment.

func (*Client) GetQueueFleetAssociation 

func (c *Client) GetQueueFleetAssociation(ctx context.Context, params *GetQueueFleetAssociationInput, optFns ...func(*Options)) (*GetQueueFleetAssociationOutput, error)

Gets a queue-fleet association.

func (*Client) GetSession 

func (c *Client) GetSession(ctx context.Context, params *GetSessionInput, optFns ...func(*Options)) (*GetSessionOutput, error)

Gets a session.

func (*Client) GetSessionAction 

func (c *Client) GetSessionAction(ctx context.Context, params *GetSessionActionInput, optFns ...func(*Options)) (*GetSessionActionOutput, error)

Gets a session action for the job.

func (*Client) GetSessionsStatisticsAggregation 

func (c *Client) GetSessionsStatisticsAggregation(ctx context.Context, params *GetSessionsStatisticsAggregationInput, optFns ...func(*Options)) (*GetSessionsStatisticsAggregationOutput, error)

Gets a set of statistics for queues or farms. Before you can call the GetSessionStatisticsAggregation operation, you must first call the StartSessionsStatisticsAggregation operation. Statistics are available for 1 hour after you call the StartSessionsStatisticsAggregation operation.

func (*Client) GetStep 

func (c *Client) GetStep(ctx context.Context, params *GetStepInput, optFns ...func(*Options)) (*GetStepOutput, error)

Gets a step.

func (*Client) GetStorageProfile 

func (c *Client) GetStorageProfile(ctx context.Context, params *GetStorageProfileInput, optFns ...func(*Options)) (*GetStorageProfileOutput, error)

Gets a storage profile.

func (*Client) GetStorageProfileForQueue 

func (c *Client) GetStorageProfileForQueue(ctx context.Context, params *GetStorageProfileForQueueInput, optFns ...func(*Options)) (*GetStorageProfileForQueueOutput, error)

Gets a storage profile for a queue.

func (*Client) GetTask 

func (c *Client) GetTask(ctx context.Context, params *GetTaskInput, optFns ...func(*Options)) (*GetTaskOutput, error)

Gets a task.

func (*Client) GetWorker 

func (c *Client) GetWorker(ctx context.Context, params *GetWorkerInput, optFns ...func(*Options)) (*GetWorkerOutput, error)

Gets a worker.

func (*Client) ListAvailableMeteredProducts 

func (c *Client) ListAvailableMeteredProducts(ctx context.Context, params *ListAvailableMeteredProductsInput, optFns ...func(*Options)) (*ListAvailableMeteredProductsOutput, error)

A list of the available metered products.

func (*Client) ListBudgets 

func (c *Client) ListBudgets(ctx context.Context, params *ListBudgetsInput, optFns ...func(*Options)) (*ListBudgetsOutput, error)

A list of budgets in a farm.

func (*Client) ListFarmMembers 

func (c *Client) ListFarmMembers(ctx context.Context, params *ListFarmMembersInput, optFns ...func(*Options)) (*ListFarmMembersOutput, error)

Lists the members of a farm.

func (*Client) ListFarms 

func (c *Client) ListFarms(ctx context.Context, params *ListFarmsInput, optFns ...func(*Options)) (*ListFarmsOutput, error)

Lists farms.

func (*Client) ListFleetMembers 

func (c *Client) ListFleetMembers(ctx context.Context, params *ListFleetMembersInput, optFns ...func(*Options)) (*ListFleetMembersOutput, error)

Lists fleet members.

func (*Client) ListFleets 

func (c *Client) ListFleets(ctx context.Context, params *ListFleetsInput, optFns ...func(*Options)) (*ListFleetsOutput, error)

Lists fleets.

func (*Client) ListJobMembers 

func (c *Client) ListJobMembers(ctx context.Context, params *ListJobMembersInput, optFns ...func(*Options)) (*ListJobMembersOutput, error)

Lists members on a job.

func (*Client) ListJobParameterDefinitions added in v1.6.0 

func (c *Client) ListJobParameterDefinitions(ctx context.Context, params *ListJobParameterDefinitionsInput, optFns ...func(*Options)) (*ListJobParameterDefinitionsOutput, error)

Lists parameter definitions of a job.

func (*Client) ListJobs 

func (c *Client) ListJobs(ctx context.Context, params *ListJobsInput, optFns ...func(*Options)) (*ListJobsOutput, error)

Lists jobs.

func (*Client) ListLicenseEndpoints 

func (c *Client) ListLicenseEndpoints(ctx context.Context, params *ListLicenseEndpointsInput, optFns ...func(*Options)) (*ListLicenseEndpointsOutput, error)

Lists license endpoints.

func (*Client) ListMeteredProducts 

func (c *Client) ListMeteredProducts(ctx context.Context, params *ListMeteredProductsInput, optFns ...func(*Options)) (*ListMeteredProductsOutput, error)

Lists metered products.

func (*Client) ListMonitors 

func (c *Client) ListMonitors(ctx context.Context, params *ListMonitorsInput, optFns ...func(*Options)) (*ListMonitorsOutput, error)

Gets a list of your monitors in Deadline Cloud.

func (*Client) ListQueueEnvironments 

func (c *Client) ListQueueEnvironments(ctx context.Context, params *ListQueueEnvironmentsInput, optFns ...func(*Options)) (*ListQueueEnvironmentsOutput, error)

Lists queue environments.

func (*Client) ListQueueFleetAssociations 

func (c *Client) ListQueueFleetAssociations(ctx context.Context, params *ListQueueFleetAssociationsInput, optFns ...func(*Options)) (*ListQueueFleetAssociationsOutput, error)

Lists queue-fleet associations.

func (*Client) ListQueueMembers 

func (c *Client) ListQueueMembers(ctx context.Context, params *ListQueueMembersInput, optFns ...func(*Options)) (*ListQueueMembersOutput, error)

Lists the members in a queue.

func (*Client) ListQueues 

func (c *Client) ListQueues(ctx context.Context, params *ListQueuesInput, optFns ...func(*Options)) (*ListQueuesOutput, error)

Lists queues.

func (*Client) ListSessionActions 

func (c *Client) ListSessionActions(ctx context.Context, params *ListSessionActionsInput, optFns ...func(*Options)) (*ListSessionActionsOutput, error)

Lists session actions.

func (*Client) ListSessions 

func (c *Client) ListSessions(ctx context.Context, params *ListSessionsInput, optFns ...func(*Options)) (*ListSessionsOutput, error)

Lists sessions.

func (*Client) ListSessionsForWorker 

func (c *Client) ListSessionsForWorker(ctx context.Context, params *ListSessionsForWorkerInput, optFns ...func(*Options)) (*ListSessionsForWorkerOutput, error)

Lists sessions for a worker.

func (*Client) ListStepConsumers 

func (c *Client) ListStepConsumers(ctx context.Context, params *ListStepConsumersInput, optFns ...func(*Options)) (*ListStepConsumersOutput, error)

Lists step consumers.

func (*Client) ListStepDependencies 

func (c *Client) ListStepDependencies(ctx context.Context, params *ListStepDependenciesInput, optFns ...func(*Options)) (*ListStepDependenciesOutput, error)

Lists the dependencies for a step.

func (*Client) ListSteps 

func (c *Client) ListSteps(ctx context.Context, params *ListStepsInput, optFns ...func(*Options)) (*ListStepsOutput, error)

Lists steps for a job.

func (*Client) ListStorageProfiles 

func (c *Client) ListStorageProfiles(ctx context.Context, params *ListStorageProfilesInput, optFns ...func(*Options)) (*ListStorageProfilesOutput, error)

Lists storage profiles.

func (*Client) ListStorageProfilesForQueue 

func (c *Client) ListStorageProfilesForQueue(ctx context.Context, params *ListStorageProfilesForQueueInput, optFns ...func(*Options)) (*ListStorageProfilesForQueueOutput, error)

Lists storage profiles for a queue.

func (*Client) ListTagsForResource 

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

Lists tags for a resource.

func (*Client) ListTasks 

func (c *Client) ListTasks(ctx context.Context, params *ListTasksInput, optFns ...func(*Options)) (*ListTasksOutput, error)

Lists tasks for a job.

func (*Client) ListWorkers 

func (c *Client) ListWorkers(ctx context.Context, params *ListWorkersInput, optFns ...func(*Options)) (*ListWorkersOutput, error)

Lists workers.

func (*Client) Options 

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) PutMeteredProduct 

func (c *Client) PutMeteredProduct(ctx context.Context, params *PutMeteredProductInput, optFns ...func(*Options)) (*PutMeteredProductOutput, error)

Adds a metered product.

func (*Client) SearchJobs 

func (c *Client) SearchJobs(ctx context.Context, params *SearchJobsInput, optFns ...func(*Options)) (*SearchJobsOutput, error)

Searches for jobs.

func (*Client) SearchSteps 

func (c *Client) SearchSteps(ctx context.Context, params *SearchStepsInput, optFns ...func(*Options)) (*SearchStepsOutput, error)

Searches for steps.

func (*Client) SearchTasks 

func (c *Client) SearchTasks(ctx context.Context, params *SearchTasksInput, optFns ...func(*Options)) (*SearchTasksOutput, error)

Searches for tasks.

func (*Client) SearchWorkers 

func (c *Client) SearchWorkers(ctx context.Context, params *SearchWorkersInput, optFns ...func(*Options)) (*SearchWorkersOutput, error)

Searches for workers.

func (*Client) StartSessionsStatisticsAggregation 

func (c *Client) StartSessionsStatisticsAggregation(ctx context.Context, params *StartSessionsStatisticsAggregationInput, optFns ...func(*Options)) (*StartSessionsStatisticsAggregationOutput, error)

Starts an asynchronous request for getting aggregated statistics about queues and farms. Get the statistics using the GetSessionsStatisticsAggregation operation. You can only have one running aggregation for your Deadline Cloud farm. Call the GetSessionsStatisticsAggregation operation and check the status field to see if an aggregation is running. Statistics are available for 1 hour after you call the StartSessionsStatisticsAggregation operation.

func (*Client) TagResource 

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Tags a resource using the resource's ARN and desired tags.

func (*Client) UntagResource 

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Removes a tag from a resource using the resource's ARN and tag to remove.

func (*Client) UpdateBudget 

func (c *Client) UpdateBudget(ctx context.Context, params *UpdateBudgetInput, optFns ...func(*Options)) (*UpdateBudgetOutput, error)

Updates a budget that sets spending thresholds for rendering activity.

func (*Client) UpdateFarm 

func (c *Client) UpdateFarm(ctx context.Context, params *UpdateFarmInput, optFns ...func(*Options)) (*UpdateFarmOutput, error)

Updates a farm.

func (*Client) UpdateFleet 

func (c *Client) UpdateFleet(ctx context.Context, params *UpdateFleetInput, optFns ...func(*Options)) (*UpdateFleetOutput, error)

Updates a fleet.

func (*Client) UpdateJob 

func (c *Client) UpdateJob(ctx context.Context, params *UpdateJobInput, optFns ...func(*Options)) (*UpdateJobOutput, error)

Updates a job.

When you change the status of the job to ARCHIVED , the job can't be scheduled or archived.

An archived jobs and its steps and tasks are deleted after 120 days. The job can't be recovered.

func (*Client) UpdateMonitor 

func (c *Client) UpdateMonitor(ctx context.Context, params *UpdateMonitorInput, optFns ...func(*Options)) (*UpdateMonitorOutput, error)

Modifies the settings for a Deadline Cloud monitor. You can modify one or all of the settings when you call UpdateMonitor .

func (*Client) UpdateQueue 

func (c *Client) UpdateQueue(ctx context.Context, params *UpdateQueueInput, optFns ...func(*Options)) (*UpdateQueueOutput, error)

Updates a queue.

func (*Client) UpdateQueueEnvironment 

func (c *Client) UpdateQueueEnvironment(ctx context.Context, params *UpdateQueueEnvironmentInput, optFns ...func(*Options)) (*UpdateQueueEnvironmentOutput, error)

Updates the queue environment.

func (*Client) UpdateQueueFleetAssociation 

func (c *Client) UpdateQueueFleetAssociation(ctx context.Context, params *UpdateQueueFleetAssociationInput, optFns ...func(*Options)) (*UpdateQueueFleetAssociationOutput, error)

Updates a queue-fleet association.

func (*Client) UpdateSession 

func (c *Client) UpdateSession(ctx context.Context, params *UpdateSessionInput, optFns ...func(*Options)) (*UpdateSessionOutput, error)

Updates a session.

func (*Client) UpdateStep 

func (c *Client) UpdateStep(ctx context.Context, params *UpdateStepInput, optFns ...func(*Options)) (*UpdateStepOutput, error)

Updates a step.

func (*Client) UpdateStorageProfile 

func (c *Client) UpdateStorageProfile(ctx context.Context, params *UpdateStorageProfileInput, optFns ...func(*Options)) (*UpdateStorageProfileOutput, error)

Updates a storage profile.

func (*Client) UpdateTask 

func (c *Client) UpdateTask(ctx context.Context, params *UpdateTaskInput, optFns ...func(*Options)) (*UpdateTaskOutput, error)

Updates a task.

func (*Client) UpdateWorker 

func (c *Client) UpdateWorker(ctx context.Context, params *UpdateWorkerInput, optFns ...func(*Options)) (*UpdateWorkerOutput, error)

Updates a worker.

func (*Client) UpdateWorkerSchedule 

func (c *Client) UpdateWorkerSchedule(ctx context.Context, params *UpdateWorkerScheduleInput, optFns ...func(*Options)) (*UpdateWorkerScheduleOutput, error)

Updates the schedule for a worker.

type CopyJobTemplateInput 

type CopyJobTemplateInput struct {

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

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

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

	// The Amazon S3 bucket name and key where you would like to add a copy of the job
	// template.
	//
	// This member is required.
	TargetS3Location *types.S3Location
	// contains filtered or unexported fields
}

type CopyJobTemplateOutput 

type CopyJobTemplateOutput struct {

	// The format of the job template, either JSON or YAML .
	//
	// This member is required.
	TemplateType types.JobTemplateType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateBudgetInput 

type CreateBudgetInput struct {

	// The budget actions to specify what happens when the budget runs out.
	//
	// This member is required.
	Actions []types.BudgetActionToAdd

	// The dollar limit based on consumed usage.
	//
	// This member is required.
	ApproximateDollarLimit *float32

	// The display name of the budget.
	//
	// 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 to include in this budget.
	//
	// This member is required.
	FarmId *string

	// The schedule to associate with this budget.
	//
	// This member is required.
	Schedule types.BudgetSchedule

	// The queue ID provided to this budget to track usage.
	//
	// This member is required.
	UsageTrackingResource types.UsageTrackingResource

	// The unique token which the server uses to recognize retries of the same request.
	ClientToken *string

	// The description of the budget.
	//
	// 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
}

type CreateBudgetOutput 

type CreateBudgetOutput struct {

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateFarmInput 

type CreateFarmInput struct {

	// 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 unique token which the server uses to recognize retries of the same request.
	ClientToken *string

	// The description 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.
	Description *string

	// The ARN of the KMS key to use on the farm.
	KmsKeyArn *string

	// The tags to add to your farm. Each tag consists of a tag key and a tag value.
	// Tag keys and values are both required, but tag values can be empty strings.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateFarmOutput 

type CreateFarmOutput struct {

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateFleetInput 

type CreateFleetInput struct {

	// The configuration settings for the fleet. Customer managed fleets are
	// self-managed. Service managed Amazon EC2 fleets are managed by Deadline Cloud.
	//
	// This member is required.
	Configuration types.FleetConfiguration

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

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

	// The IAM role ARN for the role that the fleet's workers will use.
	//
	// This member is required.
	RoleArn *string

	// The unique token which the server uses to recognize retries of the same request.
	ClientToken *string

	// The description of the fleet.
	//
	// 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

	// The minimum number of workers for the fleet.
	MinWorkerCount int32

	// Each tag consists of a tag key and a tag value. Tag keys and values are both
	// required, but tag values can be empty strings.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateFleetOutput 

type CreateFleetOutput struct {

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateJobInput 

type CreateJobInput struct {

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

	// The priority of the job on a scale of 0 to 100. The highest priority (first
	// scheduled) is 100. When two jobs have the same priority, the oldest job is
	// scheduled first.
	//
	// This member is required.
	Priority *int32

	// The ID of the queue that the job is submitted to.
	//
	// This member is required.
	QueueId *string

	// The attachments for the job. Attach files required for the job to run to a
	// render job.
	Attachments *types.Attachments

	// The unique token which the server uses to recognize retries of the same request.
	ClientToken *string

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

	// The maximum number of retries for each task.
	MaxRetriesPerTask *int32

	// The parameters for the job.
	Parameters map[string]types.JobParameter

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

	// The storage profile ID for the storage profile to connect to the job.
	StorageProfileId *string

	// The initial job status when it is created. Jobs that are created with a
	// SUSPENDED status will not run until manually requeued.
	TargetTaskRunStatus types.CreateJobTargetTaskRunStatus

	// The job template to use for this job.
	Template *string

	// The file type for the job template.
	TemplateType types.JobTemplateType
	// contains filtered or unexported fields
}

type CreateJobOutput 

type CreateJobOutput struct {

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateLicenseEndpointInput 

type CreateLicenseEndpointInput struct {

	// The security group IDs.
	//
	// This member is required.
	SecurityGroupIds []string

	// The subnet IDs.
	//
	// This member is required.
	SubnetIds []string

	// The VPC (virtual private cloud) ID to use with the license endpoint.
	//
	// This member is required.
	VpcId *string

	// The unique token which the server uses to recognize retries of the same request.
	ClientToken *string

	// Each tag consists of a tag key and a tag value. Tag keys and values are both
	// required, but tag values can be empty strings.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateLicenseEndpointOutput 

type CreateLicenseEndpointOutput struct {

	// The license endpoint ID.
	//
	// This member is required.
	LicenseEndpointId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateMonitorInput 

type CreateMonitorInput struct {

	// The name that you give the monitor that is displayed in 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) of the IAM Identity Center instance that
	// authenticates monitor users.
	//
	// This member is required.
	IdentityCenterInstanceArn *string

	// The Amazon Resource Name (ARN) of the IAM role that the monitor uses to connect
	// to Deadline Cloud. Every user that signs in to the monitor using IAM Identity
	// Center uses this role to access Deadline Cloud resources.
	//
	// This member is required.
	RoleArn *string

	// The subdomain to use when creating the monitor URL. The full URL of the monitor
	// is subdomain.Region.deadlinecloud.amazonaws.com.
	//
	// This member is required.
	Subdomain *string

	// The unique token which the server uses to recognize retries of the same request.
	ClientToken *string
	// contains filtered or unexported fields
}

type CreateMonitorOutput 

type CreateMonitorOutput struct {

	// The Amazon Resource Name (ARN) that IAM Identity Center assigns to the monitor.
	//
	// This member is required.
	IdentityCenterApplicationArn *string

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateQueueEnvironmentInput 

type CreateQueueEnvironmentInput struct {

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

	// Sets the priority of the environments in the queue from 0 to 10,000, where 0 is
	// the highest priority. If two environments share the same priority value, the
	// environment created first takes higher priority.
	//
	// This member is required.
	Priority *int32

	// The queue ID to connect the queue and environment.
	//
	// This member is required.
	QueueId *string

	// The environment template to use in the queue.
	//
	// This member is required.
	Template *string

	// The template's file type, JSON or YAML .
	//
	// This member is required.
	TemplateType types.EnvironmentTemplateType

	// The unique token which the server uses to recognize retries of the same request.
	ClientToken *string
	// contains filtered or unexported fields
}

type CreateQueueEnvironmentOutput 

type CreateQueueEnvironmentOutput struct {

	// The queue environment ID.
	//
	// This member is required.
	QueueEnvironmentId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateQueueFleetAssociationInput 

type CreateQueueFleetAssociationInput struct {

	// The ID of the farm that the queue and fleet belong to.
	//
	// This member is required.
	FarmId *string

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

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

type CreateQueueFleetAssociationOutput 

type CreateQueueFleetAssociationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateQueueInput 

type CreateQueueInput struct {

	// The display name of the queue.
	//
	// This field can store any content. Escape or encode this content before
	// displaying it on a webpage or any other system that might interpret the content
	// of this field.
	//
	// This member is required.
	DisplayName *string

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

	// The storage profile IDs to include in the queue.
	AllowedStorageProfileIds []string

	// The unique token which the server uses to recognize retries of the same request.
	ClientToken *string

	// The default action to take on a queue if a budget isn't configured.
	DefaultBudgetAction types.DefaultQueueBudgetAction

	// The description of the queue.
	//
	// This field can store any content. Escape or encode this content before
	// displaying it on a webpage or any other system that might interpret the content
	// of this field.
	Description *string

	// The job attachment settings for the queue. These are the Amazon S3 bucket name
	// and the Amazon S3 prefix.
	JobAttachmentSettings *types.JobAttachmentSettings

	// The jobs in the queue run as the specified POSIX user.
	JobRunAsUser *types.JobRunAsUser

	// The file system location name to include in the queue.
	RequiredFileSystemLocationNames []string

	// The IAM role ARN that workers will use while running jobs for this queue.
	RoleArn *string

	// Each tag consists of a tag key and a tag value. Tag keys and values are both
	// required, but tag values can be empty strings.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateQueueOutput 

type CreateQueueOutput struct {

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateStorageProfileInput 

type CreateStorageProfileInput struct {

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

	// The type of operating system (OS) for the storage profile.
	//
	// This member is required.
	OsFamily types.StorageProfileOperatingSystemFamily

	// The unique token which the server uses to recognize retries of the same request.
	ClientToken *string

	// File system paths to include in the storage profile.
	FileSystemLocations []types.FileSystemLocation
	// contains filtered or unexported fields
}

type CreateStorageProfileOutput 

type CreateStorageProfileOutput struct {

	// The storage profile ID.
	//
	// This member is required.
	StorageProfileId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateWorkerInput 

type CreateWorkerInput struct {

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

	// The fleet ID to connect to the worker.
	//
	// This member is required.
	FleetId *string

	// The unique token which the server uses to recognize retries of the same request.
	ClientToken *string

	// The IP address and host name of the worker.
	HostProperties *types.HostPropertiesRequest
	// contains filtered or unexported fields
}

type CreateWorkerOutput 

type CreateWorkerOutput struct {

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteBudgetInput 

type DeleteBudgetInput struct {

	// The budget ID of the budget to delete.
	//
	// This member is required.
	BudgetId *string

	// The farm ID of the farm to remove from the budget.
	//
	// This member is required.
	FarmId *string
	// contains filtered or unexported fields
}

type DeleteBudgetOutput 

type DeleteBudgetOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteFarmInput 

type DeleteFarmInput struct {

	// The farm ID of the farm to delete.
	//
	// This member is required.
	FarmId *string
	// contains filtered or unexported fields
}

type DeleteFarmOutput 

type DeleteFarmOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteFleetInput 

type DeleteFleetInput struct {

	// The farm ID of the farm to remove from the fleet.
	//
	// This member is required.
	FarmId *string

	// The fleet ID of the fleet to delete.
	//
	// This member is required.
	FleetId *string

	// The unique token which the server uses to recognize retries of the same request.
	ClientToken *string
	// contains filtered or unexported fields
}

type DeleteFleetOutput 

type DeleteFleetOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteLicenseEndpointInput 

type DeleteLicenseEndpointInput struct {

	// The license endpoint ID of the license endpoint to delete.
	//
	// This member is required.
	LicenseEndpointId *string
	// contains filtered or unexported fields
}

type DeleteLicenseEndpointOutput 

type DeleteLicenseEndpointOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteMeteredProductInput 

type DeleteMeteredProductInput struct {

	// The ID of the license endpoint from which to remove the metered product.
	//
	// This member is required.
	LicenseEndpointId *string

	// The product ID to remove from the license endpoint.
	//
	// This member is required.
	ProductId *string
	// contains filtered or unexported fields
}

type DeleteMeteredProductOutput 

type DeleteMeteredProductOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteMonitorInput 

type DeleteMonitorInput struct {

	// The unique identifier of the monitor to delete. This ID is returned by the
	// CreateMonitor operation, and is included in the response to the GetMonitor
	// operation.
	//
	// This member is required.
	MonitorId *string
	// contains filtered or unexported fields
}

type DeleteMonitorOutput 

type DeleteMonitorOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteQueueEnvironmentInput 

type DeleteQueueEnvironmentInput struct {

	// The farm ID of the farm from which to remove the queue environment.
	//
	// This member is required.
	FarmId *string

	// The queue environment ID of the queue environment to delete.
	//
	// This member is required.
	QueueEnvironmentId *string

	// The queue ID of the queue environment to delete.
	//
	// This member is required.
	QueueId *string
	// contains filtered or unexported fields
}

type DeleteQueueEnvironmentOutput 

type DeleteQueueEnvironmentOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteQueueFleetAssociationInput 

type DeleteQueueFleetAssociationInput struct {

	// The farm ID of the farm that holds the queue-fleet association.
	//
	// This member is required.
	FarmId *string

	// The fleet ID of the queue-fleet association.
	//
	// This member is required.
	FleetId *string

	// The queue ID of the queue-fleet association.
	//
	// This member is required.
	QueueId *string
	// contains filtered or unexported fields
}

type DeleteQueueFleetAssociationOutput 

type DeleteQueueFleetAssociationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteQueueInput 

type DeleteQueueInput struct {

	// The ID of the farm from which to remove the queue.
	//
	// This member is required.
	FarmId *string

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

type DeleteQueueOutput 

type DeleteQueueOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteStorageProfileInput 

type DeleteStorageProfileInput struct {

	// The farm ID of the farm from which to remove the storage profile.
	//
	// This member is required.
	FarmId *string

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

type DeleteStorageProfileOutput 

type DeleteStorageProfileOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteWorkerInput 

type DeleteWorkerInput struct {

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

	// The fleet ID of the worker to delete.
	//
	// This member is required.
	FleetId *string

	// The worker ID of the worker to delete.
	//
	// This member is required.
	WorkerId *string
	// contains filtered or unexported fields
}

type DeleteWorkerOutput 

type DeleteWorkerOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DisassociateMemberFromFarmInput 

type DisassociateMemberFromFarmInput struct {

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

	// A member's principal ID to disassociate from a farm.
	//
	// This member is required.
	PrincipalId *string
	// contains filtered or unexported fields
}

type DisassociateMemberFromFarmOutput 

type DisassociateMemberFromFarmOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DisassociateMemberFromFleetInput 

type DisassociateMemberFromFleetInput struct {

	// The farm ID of the fleet to disassociate a member from.
	//
	// This member is required.
	FarmId *string

	// The fleet ID of the fleet to from which to disassociate a member.
	//
	// This member is required.
	FleetId *string

	// A member's principal ID to disassociate from a fleet.
	//
	// This member is required.
	PrincipalId *string
	// contains filtered or unexported fields
}

type DisassociateMemberFromFleetOutput 

type DisassociateMemberFromFleetOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DisassociateMemberFromJobInput 

type DisassociateMemberFromJobInput struct {

	// The farm ID for the job to disassociate from the member.
	//
	// This member is required.
	FarmId *string

	// The job ID to disassociate from a member in a job.
	//
	// This member is required.
	JobId *string

	// A member's principal ID to disassociate from a job.
	//
	// This member is required.
	PrincipalId *string

	// The queue ID connected to a job for which you're disassociating a member.
	//
	// This member is required.
	QueueId *string
	// contains filtered or unexported fields
}

type DisassociateMemberFromJobOutput 

type DisassociateMemberFromJobOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DisassociateMemberFromQueueInput 

type DisassociateMemberFromQueueInput struct {

	// The farm ID for the queue to disassociate from a member.
	//
	// This member is required.
	FarmId *string

	// A member's principal ID to disassociate from a queue.
	//
	// This member is required.
	PrincipalId *string

	// The queue ID of the queue in which you're disassociating from a member.
	//
	// This member is required.
	QueueId *string
	// contains filtered or unexported fields
}

type DisassociateMemberFromQueueOutput 

type DisassociateMemberFromQueueOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointParameters 

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults 

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint 

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type FleetActiveWaiter 

type FleetActiveWaiter struct {
	// contains filtered or unexported fields
}

FleetActiveWaiter defines the waiters for FleetActive

func NewFleetActiveWaiter 

func NewFleetActiveWaiter(client GetFleetAPIClient, optFns ...func(*FleetActiveWaiterOptions)) *FleetActiveWaiter

NewFleetActiveWaiter constructs a FleetActiveWaiter.

func (*FleetActiveWaiter) Wait 

func (w *FleetActiveWaiter) Wait(ctx context.Context, params *GetFleetInput, maxWaitDur time.Duration, optFns ...func(*FleetActiveWaiterOptions)) error

Wait calls the waiter function for FleetActive waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*FleetActiveWaiter) WaitForOutput 

func (w *FleetActiveWaiter) WaitForOutput(ctx context.Context, params *GetFleetInput, maxWaitDur time.Duration, optFns ...func(*FleetActiveWaiterOptions)) (*GetFleetOutput, error)

WaitForOutput calls the waiter function for FleetActive waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type FleetActiveWaiterOptions 

type FleetActiveWaiterOptions struct {

	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// FleetActiveWaiter will use default minimum delay of 5 seconds. Note that
	// MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, FleetActiveWaiter will use default max delay of 900 seconds. Note
	// that MaxDelay must resolve to value greater than or equal to the MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state.
	//
	// By default service-modeled logic will populate this option. This option can
	// thus be used to define a custom waiter state with fall-back to service-modeled
	// waiter state mutators.The function returns an error in case of a failure state.
	// In case of retry state, this function returns a bool value of true and nil
	// error, while in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *GetFleetInput, *GetFleetOutput, error) (bool, error)
}

FleetActiveWaiterOptions are waiter options for FleetActiveWaiter

type GetBudgetInput 

type GetBudgetInput struct {

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

	// The farm ID of the farm connected to the budget.
	//
	// This member is required.
	FarmId *string
	// contains filtered or unexported fields
}

type GetBudgetOutput 

type GetBudgetOutput struct {

	// The budget actions for the budget.
	//
	// This member is required.
	Actions []types.ResponseBudgetAction

	// The consumed usage limit for 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.
	//
	// 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 budget schedule.
	//
	// This member is required.
	Schedule types.BudgetSchedule

	// The status of the budget.
	//
	//   - ACTIVE –Get a budget being evaluated.
	//
	//   - INACTIVE –Get an inactive budget. This can include expired, canceled, or
	//   deleted statuses.
	//
	// This member is required.
	Status types.BudgetStatus

	// The resource that the budget is tracking usage for.
	//
	// This member is required.
	UsageTrackingResource types.UsageTrackingResource

	// The usages of the budget.
	//
	// This member is required.
	Usages *types.ConsumedUsages

	// The description of the budget.
	//
	// 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

	// The date and time the queue stopped.
	QueueStoppedAt *time.Time

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

	// The user or system that updated this resource.
	UpdatedBy *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetFarmInput 

type GetFarmInput struct {

	// The farm ID of the farm.
	//
	// This member is required.
	FarmId *string
	// contains filtered or unexported fields
}

type GetFarmOutput 

type GetFarmOutput 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 of the farm to get.
	//
	// This member is required.
	FarmId *string

	// The ARN of the KMS key used on the farm.
	//
	// This member is required.
	KmsKeyArn *string

	// The description 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.
	Description *string

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

	// The user or system that updated this resource.
	UpdatedBy *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetFleetAPIClient 

type GetFleetAPIClient interface {
	GetFleet(context.Context, *GetFleetInput, ...func(*Options)) (*GetFleetOutput, error)
}

GetFleetAPIClient is a client that implements the GetFleet operation.

type GetFleetInput 

type GetFleetInput struct {

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

	// The fleet ID of the fleet to get.
	//
	// This member is required.
	FleetId *string
	// contains filtered or unexported fields
}

type GetFleetOutput 

type GetFleetOutput struct {

	// The configuration setting for the fleet.
	//
	// This member is required.
	Configuration types.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.
	//
	// 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 of the farm in the fleet.
	//
	// 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 specified in the fleet.
	//
	// This member is required.
	MinWorkerCount *int32

	// The IAM role ARN.
	//
	// This member is required.
	RoleArn *string

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

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

	// The Auto Scaling status of the fleet. Either GROWING , STEADY , or SHRINKING .
	AutoScalingStatus types.AutoScalingStatus

	// Outlines what the fleet is capable of for minimums, maximums, and naming, in
	// addition to attribute names and values.
	Capabilities *types.FleetCapabilities

	// The description of the fleet.
	//
	// 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

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

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

	// The user or system that updated this resource.
	UpdatedBy *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetJobAPIClient 

type GetJobAPIClient interface {
	GetJob(context.Context, *GetJobInput, ...func(*Options)) (*GetJobOutput, error)
}

GetJobAPIClient is a client that implements the GetJob operation.

type GetJobInput 

type GetJobInput struct {

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

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

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

type GetJobOutput 

type GetJobOutput 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 for the job.
	//
	// This member is required.
	LifecycleStatus types.JobLifecycleStatus

	// A message that communicates the status of the life cycle for the job.
	//
	// This member is required.
	LifecycleStatusMessage *string

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

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

	// The attachments for the job.
	Attachments *types.Attachments

	// The description of the job.
	//
	// 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

	// 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 per failed tasks.
	MaxRetriesPerTask *int32

	// The parameters for the job.
	Parameters map[string]types.JobParameter

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

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

	// The storage profile ID associated with the job.
	StorageProfileId *string

	// The task status with which the job started.
	TargetTaskRunStatus types.JobTargetTaskRunStatus

	// The task run status for the job.
	TaskRunStatus types.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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetLicenseEndpointAPIClient 

type GetLicenseEndpointAPIClient interface {
	GetLicenseEndpoint(context.Context, *GetLicenseEndpointInput, ...func(*Options)) (*GetLicenseEndpointOutput, error)
}

GetLicenseEndpointAPIClient is a client that implements the GetLicenseEndpoint operation.

type GetLicenseEndpointInput 

type GetLicenseEndpointInput struct {

	// The license endpoint ID.
	//
	// This member is required.
	LicenseEndpointId *string
	// contains filtered or unexported fields
}

type GetLicenseEndpointOutput 

type GetLicenseEndpointOutput struct {

	// The license endpoint ID.
	//
	// This member is required.
	LicenseEndpointId *string

	// The status of the license endpoint.
	//
	// This member is required.
	Status types.LicenseEndpointStatus

	// The status message of the license endpoint.
	//
	// This member is required.
	StatusMessage *string

	// The DNS name.
	DnsName *string

	// The security group IDs for the license endpoint.
	SecurityGroupIds []string

	// The subnet IDs.
	SubnetIds []string

	// The VCP(virtual private cloud) ID associated with the license endpoint.
	VpcId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetMonitorInput 

type GetMonitorInput struct {

	// The unique identifier for the monitor. This ID is returned by the CreateMonitor
	// operation.
	//
	// This member is required.
	MonitorId *string
	// contains filtered or unexported fields
}

type GetMonitorOutput 

type GetMonitorOutput 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 used to identify the monitor 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 last date and time that the monitor was updated.
	UpdatedAt *time.Time

	// The user name of the person that last updated the monitor.
	UpdatedBy *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetQueueAPIClient 

type GetQueueAPIClient interface {
	GetQueue(context.Context, *GetQueueInput, ...func(*Options)) (*GetQueueOutput, error)
}

GetQueueAPIClient is a client that implements the GetQueue operation.

type GetQueueEnvironmentInput 

type GetQueueEnvironmentInput struct {

	// The farm ID for the queue environment.
	//
	// This member is required.
	FarmId *string

	// The queue environment ID.
	//
	// This member is required.
	QueueEnvironmentId *string

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

type GetQueueEnvironmentOutput 

type GetQueueEnvironmentOutput 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 name of the queue environment.
	//
	// This member is required.
	Name *string

	// The priority of the queue environment.
	//
	// This member is required.
	Priority *int32

	// The queue environment ID.
	//
	// This member is required.
	QueueEnvironmentId *string

	// The template for the queue environment.
	//
	// This member is required.
	Template *string

	// The type of template for the queue environment.
	//
	// This member is required.
	TemplateType types.EnvironmentTemplateType

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

	// The user or system that updated this resource.
	UpdatedBy *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetQueueFleetAssociationAPIClient 

type GetQueueFleetAssociationAPIClient interface {
	GetQueueFleetAssociation(context.Context, *GetQueueFleetAssociationInput, ...func(*Options)) (*GetQueueFleetAssociationOutput, error)
}

GetQueueFleetAssociationAPIClient is a client that implements the GetQueueFleetAssociation operation.

type GetQueueFleetAssociationInput 

type GetQueueFleetAssociationInput struct {

	// The farm ID of the farm that contains the queue-fleet association.
	//
	// This member is required.
	FarmId *string

	// The fleet ID for the queue-fleet association.
	//
	// This member is required.
	FleetId *string

	// The queue ID for the queue-fleet association.
	//
	// This member is required.
	QueueId *string
	// contains filtered or unexported fields
}

type GetQueueFleetAssociationOutput 

type GetQueueFleetAssociationOutput 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 for the queue-fleet association.
	//
	// This member is required.
	FleetId *string

	// The queue ID for the queue-fleet association.
	//
	// This member is required.
	QueueId *string

	// The status of the queue-fleet association.
	//
	// This member is required.
	Status types.QueueFleetAssociationStatus

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

	// The user or system that updated this resource.
	UpdatedBy *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetQueueInput 

type GetQueueInput struct {

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

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

type GetQueueOutput 

type GetQueueOutput 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 if a budget wasn't configured.
	//
	// This member is required.
	DefaultBudgetAction types.DefaultQueueBudgetAction

	// The display name of the queue.
	//
	// This field can store any content. Escape or encode this content before
	// displaying it on a webpage or any other system that might interpret the content
	// of this field.
	//
	// This member is required.
	DisplayName *string

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

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

	// The status of the queue.
	//
	//   - ACTIVE –The queue is active.
	//
	//   - SCHEDULING –The queue is scheduling.
	//
	//   - SCHEDULING_BLOCKED –The queue scheduling is blocked. See the provided reason.
	//
	// This member is required.
	Status types.QueueStatus

	// The storage profile IDs for the queue.
	AllowedStorageProfileIds []string

	// The reason the queue was blocked.
	BlockedReason types.QueueBlockedReason

	// The description of the queue.
	//
	// This field can store any content. Escape or encode this content before
	// displaying it on a webpage or any other system that might interpret the content
	// of this field.
	Description *string

	// The job attachment settings for the queue.
	JobAttachmentSettings *types.JobAttachmentSettings

	// The jobs in the queue ran as this specified POSIX user.
	JobRunAsUser *types.JobRunAsUser

	// A list of the required file system location names in the queue.
	RequiredFileSystemLocationNames []string

	// The IAM role ARN.
	RoleArn *string

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

	// The user or system that updated this resource.
	UpdatedBy *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetSessionActionInput 

type GetSessionActionInput struct {

	// The farm ID for the session action.
	//
	// This member is required.
	FarmId *string

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

	// The queue ID for the session action.
	//
	// This member is required.
	QueueId *string

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

type GetSessionActionOutput 

type GetSessionActionOutput struct {

	// The session action definition.
	//
	// This member is required.
	Definition types.SessionActionDefinition

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

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

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

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

	// The exit code to exit the session.
	ProcessExitCode *int32

	// The message that communicates the progress of the session action.
	ProgressMessage *string

	// The percentage completed for a session action.
	ProgressPercent *float32

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

	// The Linux timestamp of the date and time the session action was last updated.
	WorkerUpdatedAt *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetSessionInput 

type GetSessionInput struct {

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

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

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

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

type GetSessionOutput 

type GetSessionOutput struct {

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

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

	// The session log.
	//
	// This member is required.
	Log *types.LogConfiguration

	// 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 for the session.
	//
	// This member is required.
	WorkerId *string

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

	// Provides the Amazon EC2 properties of the host.
	HostProperties *types.HostPropertiesResponse

	// The life cycle status with which the session started.
	TargetLifecycleStatus types.SessionLifecycleTargetStatus

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

	// The user or system that updated this resource.
	UpdatedBy *string

	// The worker log for the session.
	WorkerLog *types.LogConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetSessionsStatisticsAggregationAPIClient 

type GetSessionsStatisticsAggregationAPIClient interface {
	GetSessionsStatisticsAggregation(context.Context, *GetSessionsStatisticsAggregationInput, ...func(*Options)) (*GetSessionsStatisticsAggregationOutput, error)
}

GetSessionsStatisticsAggregationAPIClient is a client that implements the GetSessionsStatisticsAggregation operation.

type GetSessionsStatisticsAggregationInput 

type GetSessionsStatisticsAggregationInput struct {

	// The identifier returned by the StartSessionsStatisticsAggregation operation
	// that identifies the aggregated statistics.
	//
	// This member is required.
	AggregationId *string

	// The identifier of the farm to include in the statistics. This should be the
	// same as the farm ID used in the call to the StartSessionsStatisticsAggregation
	// operation.
	//
	// This member is required.
	FarmId *string

	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	MaxResults *int32

	// The token for the next set of results, or null to start from the beginning.
	NextToken *string
	// contains filtered or unexported fields
}

type GetSessionsStatisticsAggregationOutput 

type GetSessionsStatisticsAggregationOutput struct {

	// The status of the aggregated results. An aggregation may fail or time out if
	// the results are too large. If this happens, you can call the
	// StartSessionsStatisticsAggregation operation after you reduce the aggregation
	// time frame, reduce the number of queues or fleets in the aggregation, or
	// increase the period length.
	//
	// If you call the StartSessionsStatisticsAggregation  operation when the status
	// is IN_PROGRESS , you will receive a ThrottlingException .
	//
	// This member is required.
	Status types.SessionsStatisticsAggregationStatus

	// If Deadline Cloud returns nextToken , then there are more results available. The
	// value of nextToken is a unique pagination token for each page. To retrieve the
	// next page, call the operation again using the returned token. Keep all other
	// arguments unchanged. If no results remain, then nextToken is set to null . Each
	// pagination token expires after 24 hours. If you provide a token that isn't
	// valid, then you receive an HTTP 400 ValidationException error.
	NextToken *string

	// The statistics for the specified fleets or queues.
	Statistics []types.Statistics

	// A message that describes the status.
	StatusMessage *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetSessionsStatisticsAggregationPaginator 

type GetSessionsStatisticsAggregationPaginator struct {
	// contains filtered or unexported fields
}

GetSessionsStatisticsAggregationPaginator is a paginator for GetSessionsStatisticsAggregation

func NewGetSessionsStatisticsAggregationPaginator 

func NewGetSessionsStatisticsAggregationPaginator(client GetSessionsStatisticsAggregationAPIClient, params *GetSessionsStatisticsAggregationInput, optFns ...func(*GetSessionsStatisticsAggregationPaginatorOptions)) *GetSessionsStatisticsAggregationPaginator

NewGetSessionsStatisticsAggregationPaginator returns a new GetSessionsStatisticsAggregationPaginator

func (*GetSessionsStatisticsAggregationPaginator) HasMorePages 

func (p *GetSessionsStatisticsAggregationPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetSessionsStatisticsAggregationPaginator) NextPage 

func (p *GetSessionsStatisticsAggregationPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetSessionsStatisticsAggregationOutput, error)

NextPage retrieves the next GetSessionsStatisticsAggregation page.

type GetSessionsStatisticsAggregationPaginatorOptions 

type GetSessionsStatisticsAggregationPaginatorOptions struct {
	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

GetSessionsStatisticsAggregationPaginatorOptions is the paginator options for GetSessionsStatisticsAggregation

type GetStepInput 

type GetStepInput struct {

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

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

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

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

type GetStepOutput 

type GetStepOutput 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 of the step.
	//
	// This member is required.
	LifecycleStatus types.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.
	//
	// This member is required.
	TaskRunStatus types.TaskRunStatus

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

	// The number of dependencies in the step.
	DependencyCounts *types.DependencyCounts

	// The description of the step.
	//
	// 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

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

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

	// A list of step parameters and the combination expression for the step.
	ParameterSpace *types.ParameterSpace

	// The required capabilities of the step.
	RequiredCapabilities *types.StepRequiredCapabilities

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

	// The task status with which the job started.
	TargetTaskRunStatus types.StepTargetTaskRunStatus

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

	// The user or system that updated this resource.
	UpdatedBy *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetStorageProfileForQueueInput 

type GetStorageProfileForQueueInput struct {

	// The farm ID for the queue in storage profile.
	//
	// This member is required.
	FarmId *string

	// The queue ID the queue in the storage profile.
	//
	// This member is required.
	QueueId *string

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

type GetStorageProfileForQueueOutput 

type GetStorageProfileForQueueOutput struct {

	// The display name of the storage profile connected to a queue.
	//
	// This field can store any content. Escape or encode this content before
	// displaying it on a webpage or any other system that might interpret the content
	// of this field.
	//
	// This member is required.
	DisplayName *string

	// The operating system of the storage profile in the queue.
	//
	// This member is required.
	OsFamily types.StorageProfileOperatingSystemFamily

	// The storage profile ID.
	//
	// This member is required.
	StorageProfileId *string

	// The location of the files for the storage profile within the queue.
	FileSystemLocations []types.FileSystemLocation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetStorageProfileInput 

type GetStorageProfileInput struct {

	// The farm ID for the storage profile.
	//
	// This member is required.
	FarmId *string

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

type GetStorageProfileOutput 

type GetStorageProfileOutput 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 storage profile.
	//
	// 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) for the storage profile.
	//
	// This member is required.
	OsFamily types.StorageProfileOperatingSystemFamily

	// The storage profile ID.
	//
	// This member is required.
	StorageProfileId *string

	// The location of the files for the storage profile.
	FileSystemLocations []types.FileSystemLocation

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

	// The user or system that updated this resource.
	UpdatedBy *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetTaskInput 

type GetTaskInput struct {

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

	// The job ID of the job connected to the task.
	//
	// This member is required.
	JobId *string

	// The queue ID for the queue connected to the task.
	//
	// This member is required.
	QueueId *string

	// The step ID for the step connected to the task.
	//
	// This member is required.
	StepId *string

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

type GetTaskOutput 

type GetTaskOutput 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 for the task.
	//
	// This member is required.
	RunStatus types.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 ID for the task.
	LatestSessionActionId *string

	// The parameters for the task.
	Parameters map[string]types.TaskParameterValue

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

	// The run status with which to start the task.
	TargetRunStatus types.TaskTargetRunStatus

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

	// The user or system that updated this resource.
	UpdatedBy *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetWorkerInput 

type GetWorkerInput struct {

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

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

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

type GetWorkerOutput 

type GetWorkerOutput 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 types.WorkerStatus

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

	// The host properties for the worker.
	HostProperties *types.HostPropertiesResponse

	// The logs for the associated worker.
	Log *types.LogConfiguration

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

	// The user or system that updated this resource.
	UpdatedBy *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type IdempotencyTokenProvider 

type IdempotencyTokenProvider interface {
	GetIdempotencyToken() (string, error)
}

IdempotencyTokenProvider interface for providing idempotency token

type JobCreateCompleteWaiter 

type JobCreateCompleteWaiter struct {
	// contains filtered or unexported fields
}

JobCreateCompleteWaiter defines the waiters for JobCreateComplete

func NewJobCreateCompleteWaiter 

func NewJobCreateCompleteWaiter(client GetJobAPIClient, optFns ...func(*JobCreateCompleteWaiterOptions)) *JobCreateCompleteWaiter

NewJobCreateCompleteWaiter constructs a JobCreateCompleteWaiter.

func (*JobCreateCompleteWaiter) Wait 

func (w *JobCreateCompleteWaiter) Wait(ctx context.Context, params *GetJobInput, maxWaitDur time.Duration, optFns ...func(*JobCreateCompleteWaiterOptions)) error

Wait calls the waiter function for JobCreateComplete waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*JobCreateCompleteWaiter) WaitForOutput 

func (w *JobCreateCompleteWaiter) WaitForOutput(ctx context.Context, params *GetJobInput, maxWaitDur time.Duration, optFns ...func(*JobCreateCompleteWaiterOptions)) (*GetJobOutput, error)

WaitForOutput calls the waiter function for JobCreateComplete waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type JobCreateCompleteWaiterOptions 

type JobCreateCompleteWaiterOptions struct {

	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// JobCreateCompleteWaiter will use default minimum delay of 1 seconds. Note that
	// MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, JobCreateCompleteWaiter will use default max delay of 120 seconds.
	// Note that MaxDelay must resolve to value greater than or equal to the MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state.
	//
	// By default service-modeled logic will populate this option. This option can
	// thus be used to define a custom waiter state with fall-back to service-modeled
	// waiter state mutators.The function returns an error in case of a failure state.
	// In case of retry state, this function returns a bool value of true and nil
	// error, while in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *GetJobInput, *GetJobOutput, error) (bool, error)
}

JobCreateCompleteWaiterOptions are waiter options for JobCreateCompleteWaiter

type LicenseEndpointDeletedWaiter 

type LicenseEndpointDeletedWaiter struct {
	// contains filtered or unexported fields
}

LicenseEndpointDeletedWaiter defines the waiters for LicenseEndpointDeleted

func NewLicenseEndpointDeletedWaiter 

func NewLicenseEndpointDeletedWaiter(client GetLicenseEndpointAPIClient, optFns ...func(*LicenseEndpointDeletedWaiterOptions)) *LicenseEndpointDeletedWaiter

NewLicenseEndpointDeletedWaiter constructs a LicenseEndpointDeletedWaiter.

func (*LicenseEndpointDeletedWaiter) Wait 

func (w *LicenseEndpointDeletedWaiter) Wait(ctx context.Context, params *GetLicenseEndpointInput, maxWaitDur time.Duration, optFns ...func(*LicenseEndpointDeletedWaiterOptions)) error

Wait calls the waiter function for LicenseEndpointDeleted waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*LicenseEndpointDeletedWaiter) WaitForOutput 

func (w *LicenseEndpointDeletedWaiter) WaitForOutput(ctx context.Context, params *GetLicenseEndpointInput, maxWaitDur time.Duration, optFns ...func(*LicenseEndpointDeletedWaiterOptions)) (*GetLicenseEndpointOutput, error)

WaitForOutput calls the waiter function for LicenseEndpointDeleted waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type LicenseEndpointDeletedWaiterOptions 

type LicenseEndpointDeletedWaiterOptions struct {

	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// LicenseEndpointDeletedWaiter will use default minimum delay of 10 seconds. Note
	// that MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, LicenseEndpointDeletedWaiter will use default max delay of 2340
	// seconds. Note that MaxDelay must resolve to value greater than or equal to the
	// MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state.
	//
	// By default service-modeled logic will populate this option. This option can
	// thus be used to define a custom waiter state with fall-back to service-modeled
	// waiter state mutators.The function returns an error in case of a failure state.
	// In case of retry state, this function returns a bool value of true and nil
	// error, while in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *GetLicenseEndpointInput, *GetLicenseEndpointOutput, error) (bool, error)
}

LicenseEndpointDeletedWaiterOptions are waiter options for LicenseEndpointDeletedWaiter

type LicenseEndpointValidWaiter 

type LicenseEndpointValidWaiter struct {
	// contains filtered or unexported fields
}

LicenseEndpointValidWaiter defines the waiters for LicenseEndpointValid

func NewLicenseEndpointValidWaiter 

func NewLicenseEndpointValidWaiter(client GetLicenseEndpointAPIClient, optFns ...func(*LicenseEndpointValidWaiterOptions)) *LicenseEndpointValidWaiter

NewLicenseEndpointValidWaiter constructs a LicenseEndpointValidWaiter.

func (*LicenseEndpointValidWaiter) Wait 

func (w *LicenseEndpointValidWaiter) Wait(ctx context.Context, params *GetLicenseEndpointInput, maxWaitDur time.Duration, optFns ...func(*LicenseEndpointValidWaiterOptions)) error

Wait calls the waiter function for LicenseEndpointValid waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*LicenseEndpointValidWaiter) WaitForOutput 

func (w *LicenseEndpointValidWaiter) WaitForOutput(ctx context.Context, params *GetLicenseEndpointInput, maxWaitDur time.Duration, optFns ...func(*LicenseEndpointValidWaiterOptions)) (*GetLicenseEndpointOutput, error)

WaitForOutput calls the waiter function for LicenseEndpointValid waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type LicenseEndpointValidWaiterOptions 

type LicenseEndpointValidWaiterOptions struct {

	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// LicenseEndpointValidWaiter will use default minimum delay of 10 seconds. Note
	// that MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, LicenseEndpointValidWaiter will use default max delay of 1140
	// seconds. Note that MaxDelay must resolve to value greater than or equal to the
	// MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state.
	//
	// By default service-modeled logic will populate this option. This option can
	// thus be used to define a custom waiter state with fall-back to service-modeled
	// waiter state mutators.The function returns an error in case of a failure state.
	// In case of retry state, this function returns a bool value of true and nil
	// error, while in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *GetLicenseEndpointInput, *GetLicenseEndpointOutput, error) (bool, error)
}

LicenseEndpointValidWaiterOptions are waiter options for LicenseEndpointValidWaiter

type ListAvailableMeteredProductsAPIClient 

type ListAvailableMeteredProductsAPIClient interface {
	ListAvailableMeteredProducts(context.Context, *ListAvailableMeteredProductsInput, ...func(*Options)) (*ListAvailableMeteredProductsOutput, error)
}

ListAvailableMeteredProductsAPIClient is a client that implements the ListAvailableMeteredProducts operation.

type ListAvailableMeteredProductsInput 

type ListAvailableMeteredProductsInput struct {

	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	MaxResults *int32

	// The token for the next set of results, or null to start from the beginning.
	NextToken *string
	// contains filtered or unexported fields
}

type ListAvailableMeteredProductsOutput 

type ListAvailableMeteredProductsOutput struct {

	// The metered products.
	//
	// This member is required.
	MeteredProducts []types.MeteredProductSummary

	// If Deadline Cloud returns nextToken , then there are more results available. The
	// value of nextToken is a unique pagination token for each page. To retrieve the
	// next page, call the operation again using the returned token. Keep all other
	// arguments unchanged. If no results remain, then nextToken is set to null . Each
	// pagination token expires after 24 hours. If you provide a token that isn't
	// valid, then you receive an HTTP 400 ValidationException error.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListAvailableMeteredProductsPaginator 

type ListAvailableMeteredProductsPaginator struct {
	// contains filtered or unexported fields
}

ListAvailableMeteredProductsPaginator is a paginator for ListAvailableMeteredProducts

func NewListAvailableMeteredProductsPaginator 

func NewListAvailableMeteredProductsPaginator(client ListAvailableMeteredProductsAPIClient, params *ListAvailableMeteredProductsInput, optFns ...func(*ListAvailableMeteredProductsPaginatorOptions)) *ListAvailableMeteredProductsPaginator

NewListAvailableMeteredProductsPaginator returns a new ListAvailableMeteredProductsPaginator

func (*ListAvailableMeteredProductsPaginator) HasMorePages 

func (p *ListAvailableMeteredProductsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAvailableMeteredProductsPaginator) NextPage 

func (p *ListAvailableMeteredProductsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAvailableMeteredProductsOutput, error)

NextPage retrieves the next ListAvailableMeteredProducts page.

type ListAvailableMeteredProductsPaginatorOptions 

type ListAvailableMeteredProductsPaginatorOptions struct {
	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListAvailableMeteredProductsPaginatorOptions is the paginator options for ListAvailableMeteredProducts

type ListBudgetsAPIClient 

type ListBudgetsAPIClient interface {
	ListBudgets(context.Context, *ListBudgetsInput, ...func(*Options)) (*ListBudgetsOutput, error)
}

ListBudgetsAPIClient is a client that implements the ListBudgets operation.

type ListBudgetsInput 

type ListBudgetsInput struct {

	// The farm ID associated with the budgets.
	//
	// This member is required.
	FarmId *string

	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	MaxResults *int32

	// The token for the next set of results, or null to start from the beginning.
	NextToken *string

	// The status to list for the budgets.
	Status types.BudgetStatus
	// contains filtered or unexported fields
}

type ListBudgetsOutput 

type ListBudgetsOutput struct {

	// The budgets to include on the list.
	//
	// This member is required.
	Budgets []types.BudgetSummary

	// If Deadline Cloud returns nextToken , then there are more results available. The
	// value of nextToken is a unique pagination token for each page. To retrieve the
	// next page, call the operation again using the returned token. Keep all other
	// arguments unchanged. If no results remain, then nextToken is set to null . Each
	// pagination token expires after 24 hours. If you provide a token that isn't
	// valid, then you receive an HTTP 400 ValidationException error.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListBudgetsPaginator 

type ListBudgetsPaginator struct {
	// contains filtered or unexported fields
}

ListBudgetsPaginator is a paginator for ListBudgets

func NewListBudgetsPaginator 

func NewListBudgetsPaginator(client ListBudgetsAPIClient, params *ListBudgetsInput, optFns ...func(*ListBudgetsPaginatorOptions)) *ListBudgetsPaginator

NewListBudgetsPaginator returns a new ListBudgetsPaginator

func (*ListBudgetsPaginator) HasMorePages 

func (p *ListBudgetsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListBudgetsPaginator) NextPage 

func (p *ListBudgetsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListBudgetsOutput, error)

NextPage retrieves the next ListBudgets page.

type ListBudgetsPaginatorOptions 

type ListBudgetsPaginatorOptions struct {
	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListBudgetsPaginatorOptions is the paginator options for ListBudgets

type ListFarmMembersAPIClient 

type ListFarmMembersAPIClient interface {
	ListFarmMembers(context.Context, *ListFarmMembersInput, ...func(*Options)) (*ListFarmMembersOutput, error)
}

ListFarmMembersAPIClient is a client that implements the ListFarmMembers operation.

type ListFarmMembersInput 

type ListFarmMembersInput struct {

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

	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	MaxResults *int32

	// The token for the next set of results, or null to start from the beginning.
	NextToken *string
	// contains filtered or unexported fields
}

type ListFarmMembersOutput 

type ListFarmMembersOutput struct {

	// The members on the list.
	//
	// This member is required.
	Members []types.FarmMember

	// If Deadline Cloud returns nextToken , then there are more results available. The
	// value of nextToken is a unique pagination token for each page. To retrieve the
	// next page, call the operation again using the returned token. Keep all other
	// arguments unchanged. If no results remain, then nextToken is set to null . Each
	// pagination token expires after 24 hours. If you provide a token that isn't
	// valid, then you receive an HTTP 400 ValidationException error.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListFarmMembersPaginator 

type ListFarmMembersPaginator struct {
	// contains filtered or unexported fields
}

ListFarmMembersPaginator is a paginator for ListFarmMembers

func NewListFarmMembersPaginator 

func NewListFarmMembersPaginator(client ListFarmMembersAPIClient, params *ListFarmMembersInput, optFns ...func(*ListFarmMembersPaginatorOptions)) *ListFarmMembersPaginator

NewListFarmMembersPaginator returns a new ListFarmMembersPaginator

func (*ListFarmMembersPaginator) HasMorePages 

func (p *ListFarmMembersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListFarmMembersPaginator) NextPage 

func (p *ListFarmMembersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListFarmMembersOutput, error)

NextPage retrieves the next ListFarmMembers page.

type ListFarmMembersPaginatorOptions 

type ListFarmMembersPaginatorOptions struct {
	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListFarmMembersPaginatorOptions is the paginator options for ListFarmMembers

type ListFarmsAPIClient 

type ListFarmsAPIClient interface {
	ListFarms(context.Context, *ListFarmsInput, ...func(*Options)) (*ListFarmsOutput, error)
}

ListFarmsAPIClient is a client that implements the ListFarms operation.

type ListFarmsInput 

type ListFarmsInput struct {

	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	MaxResults *int32

	// The token for the next set of results, or null to start from the beginning.
	NextToken *string

	// The principal ID of the member to list on the farm.
	PrincipalId *string
	// contains filtered or unexported fields
}

type ListFarmsOutput 

type ListFarmsOutput struct {

	// Farms on the list.
	//
	// This member is required.
	Farms []types.FarmSummary

	// If Deadline Cloud returns nextToken , then there are more results available. The
	// value of nextToken is a unique pagination token for each page. To retrieve the
	// next page, call the operation again using the returned token. Keep all other
	// arguments unchanged. If no results remain, then nextToken is set to null . Each
	// pagination token expires after 24 hours. If you provide a token that isn't
	// valid, then you receive an HTTP 400 ValidationException error.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListFarmsPaginator 

type ListFarmsPaginator struct {
	// contains filtered or unexported fields
}

ListFarmsPaginator is a paginator for ListFarms

func NewListFarmsPaginator 

func NewListFarmsPaginator(client ListFarmsAPIClient, params *ListFarmsInput, optFns ...func(*ListFarmsPaginatorOptions)) *ListFarmsPaginator

NewListFarmsPaginator returns a new ListFarmsPaginator

func (*ListFarmsPaginator) HasMorePages 

func (p *ListFarmsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListFarmsPaginator) NextPage 

func (p *ListFarmsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListFarmsOutput, error)

NextPage retrieves the next ListFarms page.

type ListFarmsPaginatorOptions 

type ListFarmsPaginatorOptions struct {
	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListFarmsPaginatorOptions is the paginator options for ListFarms

type ListFleetMembersAPIClient 

type ListFleetMembersAPIClient interface {
	ListFleetMembers(context.Context, *ListFleetMembersInput, ...func(*Options)) (*ListFleetMembersOutput, error)
}

ListFleetMembersAPIClient is a client that implements the ListFleetMembers operation.

type ListFleetMembersInput 

type ListFleetMembersInput struct {

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

	// The fleet ID to include on the list.
	//
	// This member is required.
	FleetId *string

	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	MaxResults *int32

	// The token for the next set of results, or null to start from the beginning.
	NextToken *string
	// contains filtered or unexported fields
}

type ListFleetMembersOutput 

type ListFleetMembersOutput struct {

	// The members on the list.
	//
	// This member is required.
	Members []types.FleetMember

	// If Deadline Cloud returns nextToken , then there are more results available. The
	// value of nextToken is a unique pagination token for each page. To retrieve the
	// next page, call the operation again using the returned token. Keep all other
	// arguments unchanged. If no results remain, then nextToken is set to null . Each
	// pagination token expires after 24 hours. If you provide a token that isn't
	// valid, then you receive an HTTP 400 ValidationException error.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListFleetMembersPaginator 

type ListFleetMembersPaginator struct {
	// contains filtered or unexported fields
}

ListFleetMembersPaginator is a paginator for ListFleetMembers

func NewListFleetMembersPaginator 

func NewListFleetMembersPaginator(client ListFleetMembersAPIClient, params *ListFleetMembersInput, optFns ...func(*ListFleetMembersPaginatorOptions)) *ListFleetMembersPaginator

NewListFleetMembersPaginator returns a new ListFleetMembersPaginator

func (*ListFleetMembersPaginator) HasMorePages 

func (p *ListFleetMembersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListFleetMembersPaginator) NextPage 

func (p *ListFleetMembersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListFleetMembersOutput, error)

NextPage retrieves the next ListFleetMembers page.

type ListFleetMembersPaginatorOptions 

type ListFleetMembersPaginatorOptions struct {
	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListFleetMembersPaginatorOptions is the paginator options for ListFleetMembers

type ListFleetsAPIClient 

type ListFleetsAPIClient interface {
	ListFleets(context.Context, *ListFleetsInput, ...func(*Options)) (*ListFleetsOutput, error)
}

ListFleetsAPIClient is a client that implements the ListFleets operation.

type ListFleetsInput 

type ListFleetsInput struct {

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

	// The display names of a list of fleets.
	//
	// 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.
	DisplayName *string

	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	MaxResults *int32

	// The token for the next set of results, or null to start from the beginning.
	NextToken *string

	// The principal ID of the members to include in the fleet.
	PrincipalId *string

	// The status of the fleet.
	Status types.FleetStatus
	// contains filtered or unexported fields
}

type ListFleetsOutput 

type ListFleetsOutput struct {

	// The fleets on the list.
	//
	// This member is required.
	Fleets []types.FleetSummary

	// If Deadline Cloud returns nextToken , then there are more results available. The
	// value of nextToken is a unique pagination token for each page. To retrieve the
	// next page, call the operation again using the returned token. Keep all other
	// arguments unchanged. If no results remain, then nextToken is set to null . Each
	// pagination token expires after 24 hours. If you provide a token that isn't
	// valid, then you receive an HTTP 400 ValidationException error.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListFleetsPaginator 

type ListFleetsPaginator struct {
	// contains filtered or unexported fields
}

ListFleetsPaginator is a paginator for ListFleets

func NewListFleetsPaginator 

func NewListFleetsPaginator(client ListFleetsAPIClient, params *ListFleetsInput, optFns ...func(*ListFleetsPaginatorOptions)) *ListFleetsPaginator

NewListFleetsPaginator returns a new ListFleetsPaginator

func (*ListFleetsPaginator) HasMorePages 

func (p *ListFleetsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListFleetsPaginator) NextPage 

func (p *ListFleetsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListFleetsOutput, error)

NextPage retrieves the next ListFleets page.

type ListFleetsPaginatorOptions 

type ListFleetsPaginatorOptions struct {
	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListFleetsPaginatorOptions is the paginator options for ListFleets

type ListJobMembersAPIClient 

type ListJobMembersAPIClient interface {
	ListJobMembers(context.Context, *ListJobMembersInput, ...func(*Options)) (*ListJobMembersOutput, error)
}

ListJobMembersAPIClient is a client that implements the ListJobMembers operation.

type ListJobMembersInput 

type ListJobMembersInput struct {

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

	// The job ID to include on the list.
	//
	// This member is required.
	JobId *string

	// The queue ID to include on the list.
	//
	// This member is required.
	QueueId *string

	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	MaxResults *int32

	// The token for the next set of results, or null to start from the beginning.
	NextToken *string
	// contains filtered or unexported fields
}

type ListJobMembersOutput 

type ListJobMembersOutput struct {

	// The members on the list.
	//
	// This member is required.
	Members []types.JobMember

	// If Deadline Cloud returns nextToken , then there are more results available. The
	// value of nextToken is a unique pagination token for each page. To retrieve the
	// next page, call the operation again using the returned token. Keep all other
	// arguments unchanged. If no results remain, then nextToken is set to null . Each
	// pagination token expires after 24 hours. If you provide a token that isn't
	// valid, then you receive an HTTP 400 ValidationException error.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListJobMembersPaginator 

type ListJobMembersPaginator struct {
	// contains filtered or unexported fields
}

ListJobMembersPaginator is a paginator for ListJobMembers

func NewListJobMembersPaginator 

func NewListJobMembersPaginator(client ListJobMembersAPIClient, params *ListJobMembersInput, optFns ...func(*ListJobMembersPaginatorOptions)) *ListJobMembersPaginator

NewListJobMembersPaginator returns a new ListJobMembersPaginator

func (*ListJobMembersPaginator) HasMorePages 

func (p *ListJobMembersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListJobMembersPaginator) NextPage 

func (p *ListJobMembersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListJobMembersOutput, error)

NextPage retrieves the next ListJobMembers page.

type ListJobMembersPaginatorOptions 

type ListJobMembersPaginatorOptions struct {
	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListJobMembersPaginatorOptions is the paginator options for ListJobMembers

type ListJobParameterDefinitionsAPIClient added in v1.6.0 

type ListJobParameterDefinitionsAPIClient interface {
	ListJobParameterDefinitions(context.Context, *ListJobParameterDefinitionsInput, ...func(*Options)) (*ListJobParameterDefinitionsOutput, error)
}

ListJobParameterDefinitionsAPIClient is a client that implements the ListJobParameterDefinitions operation.

type ListJobParameterDefinitionsInput added in v1.6.0 

type ListJobParameterDefinitionsInput struct {

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

	// The job ID to include on the list.
	//
	// This member is required.
	JobId *string

	// The queue ID to include on the list.
	//
	// This member is required.
	QueueId *string

	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	MaxResults *int32

	// The token for the next set of results, or null to start from the beginning.
	NextToken *string
	// contains filtered or unexported fields
}

type ListJobParameterDefinitionsOutput added in v1.6.0 

type ListJobParameterDefinitionsOutput struct {

	// Lists parameter definitions of a job.
	//
	// This member is required.
	JobParameterDefinitions []document.Interface

	// If Deadline Cloud returns nextToken , then there are more results available. The
	// value of nextToken is a unique pagination token for each page. To retrieve the
	// next page, call the operation again using the returned token. Keep all other
	// arguments unchanged. If no results remain, then nextToken is set to null . Each
	// pagination token expires after 24 hours. If you provide a token that isn't
	// valid, then you receive an HTTP 400 ValidationException error.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListJobParameterDefinitionsPaginator added in v1.6.0 

type ListJobParameterDefinitionsPaginator struct {
	// contains filtered or unexported fields
}

ListJobParameterDefinitionsPaginator is a paginator for ListJobParameterDefinitions

func NewListJobParameterDefinitionsPaginator added in v1.6.0 

func NewListJobParameterDefinitionsPaginator(client ListJobParameterDefinitionsAPIClient, params *ListJobParameterDefinitionsInput, optFns ...func(*ListJobParameterDefinitionsPaginatorOptions)) *ListJobParameterDefinitionsPaginator

NewListJobParameterDefinitionsPaginator returns a new ListJobParameterDefinitionsPaginator

func (*ListJobParameterDefinitionsPaginator) HasMorePages added in v1.6.0 

func (p *ListJobParameterDefinitionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListJobParameterDefinitionsPaginator) NextPage added in v1.6.0 

func (p *ListJobParameterDefinitionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListJobParameterDefinitionsOutput, error)

NextPage retrieves the next ListJobParameterDefinitions page.

type ListJobParameterDefinitionsPaginatorOptions added in v1.6.0 

type ListJobParameterDefinitionsPaginatorOptions struct {
	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListJobParameterDefinitionsPaginatorOptions is the paginator options for ListJobParameterDefinitions

type ListJobsAPIClient 

type ListJobsAPIClient interface {
	ListJobs(context.Context, *ListJobsInput, ...func(*Options)) (*ListJobsOutput, error)
}

ListJobsAPIClient is a client that implements the ListJobs operation.

type ListJobsInput 

type ListJobsInput struct {

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

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

	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	MaxResults *int32

	// The token for the next set of results, or null to start from the beginning.
	NextToken *string

	// The principal ID of the members on the jobs.
	PrincipalId *string
	// contains filtered or unexported fields
}

type ListJobsOutput 

type ListJobsOutput struct {

	// The jobs on the list.
	//
	// This member is required.
	Jobs []types.JobSummary

	// If Deadline Cloud returns nextToken , then there are more results available. The
	// value of nextToken is a unique pagination token for each page. To retrieve the
	// next page, call the operation again using the returned token. Keep all other
	// arguments unchanged. If no results remain, then nextToken is set to null . Each
	// pagination token expires after 24 hours. If you provide a token that isn't
	// valid, then you receive an HTTP 400 ValidationException error.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListJobsPaginator 

type ListJobsPaginator struct {
	// contains filtered or unexported fields
}

ListJobsPaginator is a paginator for ListJobs

func NewListJobsPaginator 

func NewListJobsPaginator(client ListJobsAPIClient, params *ListJobsInput, optFns ...func(*ListJobsPaginatorOptions)) *ListJobsPaginator

NewListJobsPaginator returns a new ListJobsPaginator

func (*ListJobsPaginator) HasMorePages 

func (p *ListJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListJobsPaginator) NextPage 

func (p *ListJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListJobsOutput, error)

NextPage retrieves the next ListJobs page.

type ListJobsPaginatorOptions 

type ListJobsPaginatorOptions struct {
	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListJobsPaginatorOptions is the paginator options for ListJobs

type ListLicenseEndpointsAPIClient 

type ListLicenseEndpointsAPIClient interface {
	ListLicenseEndpoints(context.Context, *ListLicenseEndpointsInput, ...func(*Options)) (*ListLicenseEndpointsOutput, error)
}

ListLicenseEndpointsAPIClient is a client that implements the ListLicenseEndpoints operation.

type ListLicenseEndpointsInput 

type ListLicenseEndpointsInput struct {

	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	MaxResults *int32

	// The token for the next set of results, or null to start from the beginning.
	NextToken *string
	// contains filtered or unexported fields
}

type ListLicenseEndpointsOutput 

type ListLicenseEndpointsOutput struct {

	// The license endpoints.
	//
	// This member is required.
	LicenseEndpoints []types.LicenseEndpointSummary

	// If Deadline Cloud returns nextToken , then there are more results available. The
	// value of nextToken is a unique pagination token for each page. To retrieve the
	// next page, call the operation again using the returned token. Keep all other
	// arguments unchanged. If no results remain, then nextToken is set to null . Each
	// pagination token expires after 24 hours. If you provide a token that isn't
	// valid, then you receive an HTTP 400 ValidationException error.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListLicenseEndpointsPaginator 

type ListLicenseEndpointsPaginator struct {
	// contains filtered or unexported fields
}

ListLicenseEndpointsPaginator is a paginator for ListLicenseEndpoints

func NewListLicenseEndpointsPaginator 

func NewListLicenseEndpointsPaginator(client ListLicenseEndpointsAPIClient, params *ListLicenseEndpointsInput, optFns ...func(*ListLicenseEndpointsPaginatorOptions)) *ListLicenseEndpointsPaginator

NewListLicenseEndpointsPaginator returns a new ListLicenseEndpointsPaginator

func (*ListLicenseEndpointsPaginator) HasMorePages 

func (p *ListLicenseEndpointsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListLicenseEndpointsPaginator) NextPage 

func (p *ListLicenseEndpointsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListLicenseEndpointsOutput, error)

NextPage retrieves the next ListLicenseEndpoints page.

type ListLicenseEndpointsPaginatorOptions 

type ListLicenseEndpointsPaginatorOptions struct {
	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListLicenseEndpointsPaginatorOptions is the paginator options for ListLicenseEndpoints

type ListMeteredProductsAPIClient 

type ListMeteredProductsAPIClient interface {
	ListMeteredProducts(context.Context, *ListMeteredProductsInput, ...func(*Options)) (*ListMeteredProductsOutput, error)
}

ListMeteredProductsAPIClient is a client that implements the ListMeteredProducts operation.

type ListMeteredProductsInput 

type ListMeteredProductsInput struct {

	// The license endpoint ID to include on the list of metered products.
	//
	// This member is required.
	LicenseEndpointId *string

	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	MaxResults *int32

	// The token for the next set of results, or null to start from the beginning.
	NextToken *string
	// contains filtered or unexported fields
}

type ListMeteredProductsOutput 

type ListMeteredProductsOutput struct {

	// The metered products to list.
	//
	// This member is required.
	MeteredProducts []types.MeteredProductSummary

	// If Deadline Cloud returns nextToken , then there are more results available. The
	// value of nextToken is a unique pagination token for each page. To retrieve the
	// next page, call the operation again using the returned token. Keep all other
	// arguments unchanged. If no results remain, then nextToken is set to null . Each
	// pagination token expires after 24 hours. If you provide a token that isn't
	// valid, then you receive an HTTP 400 ValidationException error.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListMeteredProductsPaginator 

type ListMeteredProductsPaginator struct {
	// contains filtered or unexported fields
}

ListMeteredProductsPaginator is a paginator for ListMeteredProducts

func NewListMeteredProductsPaginator 

func NewListMeteredProductsPaginator(client ListMeteredProductsAPIClient, params *ListMeteredProductsInput, optFns ...func(*ListMeteredProductsPaginatorOptions)) *ListMeteredProductsPaginator

NewListMeteredProductsPaginator returns a new ListMeteredProductsPaginator

func (*ListMeteredProductsPaginator) HasMorePages 

func (p *ListMeteredProductsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListMeteredProductsPaginator) NextPage 

func (p *ListMeteredProductsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListMeteredProductsOutput, error)

NextPage retrieves the next ListMeteredProducts page.

type ListMeteredProductsPaginatorOptions 

type ListMeteredProductsPaginatorOptions struct {
	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListMeteredProductsPaginatorOptions is the paginator options for ListMeteredProducts

type ListMonitorsAPIClient 

type ListMonitorsAPIClient interface {
	ListMonitors(context.Context, *ListMonitorsInput, ...func(*Options)) (*ListMonitorsOutput, error)
}

ListMonitorsAPIClient is a client that implements the ListMonitors operation.

type ListMonitorsInput 

type ListMonitorsInput struct {

	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	MaxResults *int32

	// The token for the next set of results, or null to start from the beginning.
	NextToken *string
	// contains filtered or unexported fields
}

type ListMonitorsOutput 

type ListMonitorsOutput struct {

	// A list of MonitorSummary objects that describe your monitors in the Deadline
	// Cloud.
	//
	// This member is required.
	Monitors []types.MonitorSummary

	// If Deadline Cloud returns nextToken , then there are more results available. The
	// value of nextToken is a unique pagination token for each page. To retrieve the
	// next page, call the operation again using the returned token. Keep all other
	// arguments unchanged. If no results remain, then nextToken is set to null . Each
	// pagination token expires after 24 hours. If you provide a token that isn't
	// valid, then you receive an HTTP 400 ValidationException error.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListMonitorsPaginator 

type ListMonitorsPaginator struct {
	// contains filtered or unexported fields
}

ListMonitorsPaginator is a paginator for ListMonitors

func NewListMonitorsPaginator 

func NewListMonitorsPaginator(client ListMonitorsAPIClient, params *ListMonitorsInput, optFns ...func(*ListMonitorsPaginatorOptions)) *ListMonitorsPaginator

NewListMonitorsPaginator returns a new ListMonitorsPaginator

func (*ListMonitorsPaginator) HasMorePages 

func (p *ListMonitorsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListMonitorsPaginator) NextPage 

func (p *ListMonitorsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListMonitorsOutput, error)

NextPage retrieves the next ListMonitors page.

type ListMonitorsPaginatorOptions 

type ListMonitorsPaginatorOptions struct {
	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListMonitorsPaginatorOptions is the paginator options for ListMonitors

type ListQueueEnvironmentsAPIClient 

type ListQueueEnvironmentsAPIClient interface {
	ListQueueEnvironments(context.Context, *ListQueueEnvironmentsInput, ...func(*Options)) (*ListQueueEnvironmentsOutput, error)
}

ListQueueEnvironmentsAPIClient is a client that implements the ListQueueEnvironments operation.

type ListQueueEnvironmentsInput 

type ListQueueEnvironmentsInput struct {

	// The farm ID for the queue environment list.
	//
	// This member is required.
	FarmId *string

	// The queue ID for the queue environment list.
	//
	// This member is required.
	QueueId *string

	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	MaxResults *int32

	// The token for the next set of results, or null to start from the beginning.
	NextToken *string
	// contains filtered or unexported fields
}

type ListQueueEnvironmentsOutput 

type ListQueueEnvironmentsOutput struct {

	// The environments to include in the queue environments list.
	//
	// This member is required.
	Environments []types.QueueEnvironmentSummary

	// If Deadline Cloud returns nextToken , then there are more results available. The
	// value of nextToken is a unique pagination token for each page. To retrieve the
	// next page, call the operation again using the returned token. Keep all other
	// arguments unchanged. If no results remain, then nextToken is set to null . Each
	// pagination token expires after 24 hours. If you provide a token that isn't
	// valid, then you receive an HTTP 400 ValidationException error.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListQueueEnvironmentsPaginator 

type ListQueueEnvironmentsPaginator struct {
	// contains filtered or unexported fields
}

ListQueueEnvironmentsPaginator is a paginator for ListQueueEnvironments

func NewListQueueEnvironmentsPaginator 

func NewListQueueEnvironmentsPaginator(client ListQueueEnvironmentsAPIClient, params *ListQueueEnvironmentsInput, optFns ...func(*ListQueueEnvironmentsPaginatorOptions)) *ListQueueEnvironmentsPaginator

NewListQueueEnvironmentsPaginator returns a new ListQueueEnvironmentsPaginator

func (*ListQueueEnvironmentsPaginator) HasMorePages 

func (p *ListQueueEnvironmentsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListQueueEnvironmentsPaginator) NextPage 

func (p *ListQueueEnvironmentsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListQueueEnvironmentsOutput, error)

NextPage retrieves the next ListQueueEnvironments page.

type ListQueueEnvironmentsPaginatorOptions 

type ListQueueEnvironmentsPaginatorOptions struct {
	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListQueueEnvironmentsPaginatorOptions is the paginator options for ListQueueEnvironments

type ListQueueFleetAssociationsAPIClient 

type ListQueueFleetAssociationsAPIClient interface {
	ListQueueFleetAssociations(context.Context, *ListQueueFleetAssociationsInput, ...func(*Options)) (*ListQueueFleetAssociationsOutput, error)
}

ListQueueFleetAssociationsAPIClient is a client that implements the ListQueueFleetAssociations operation.

type ListQueueFleetAssociationsInput 

type ListQueueFleetAssociationsInput struct {

	// The farm ID for the queue-fleet association list.
	//
	// This member is required.
	FarmId *string

	// The fleet ID for the queue-fleet association list.
	FleetId *string

	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	MaxResults *int32

	// The token for the next set of results, or null to start from the beginning.
	NextToken *string

	// The queue ID for the queue-fleet association list.
	QueueId *string
	// contains filtered or unexported fields
}

type ListQueueFleetAssociationsOutput 

type ListQueueFleetAssociationsOutput struct {

	// The queue-fleet associations on the list.
	//
	// This member is required.
	QueueFleetAssociations []types.QueueFleetAssociationSummary

	// If Deadline Cloud returns nextToken , then there are more results available. The
	// value of nextToken is a unique pagination token for each page. To retrieve the
	// next page, call the operation again using the returned token. Keep all other
	// arguments unchanged. If no results remain, then nextToken is set to null . Each
	// pagination token expires after 24 hours. If you provide a token that isn't
	// valid, then you receive an HTTP 400 ValidationException error.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListQueueFleetAssociationsPaginator 

type ListQueueFleetAssociationsPaginator struct {
	// contains filtered or unexported fields
}

ListQueueFleetAssociationsPaginator is a paginator for ListQueueFleetAssociations

func NewListQueueFleetAssociationsPaginator 

func NewListQueueFleetAssociationsPaginator(client ListQueueFleetAssociationsAPIClient, params *ListQueueFleetAssociationsInput, optFns ...func(*ListQueueFleetAssociationsPaginatorOptions)) *ListQueueFleetAssociationsPaginator

NewListQueueFleetAssociationsPaginator returns a new ListQueueFleetAssociationsPaginator

func (*ListQueueFleetAssociationsPaginator) HasMorePages 

func (p *ListQueueFleetAssociationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListQueueFleetAssociationsPaginator) NextPage 

func (p *ListQueueFleetAssociationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListQueueFleetAssociationsOutput, error)

NextPage retrieves the next ListQueueFleetAssociations page.

type ListQueueFleetAssociationsPaginatorOptions 

type ListQueueFleetAssociationsPaginatorOptions struct {
	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListQueueFleetAssociationsPaginatorOptions is the paginator options for ListQueueFleetAssociations

type ListQueueMembersAPIClient 

type ListQueueMembersAPIClient interface {
	ListQueueMembers(context.Context, *ListQueueMembersInput, ...func(*Options)) (*ListQueueMembersOutput, error)
}

ListQueueMembersAPIClient is a client that implements the ListQueueMembers operation.

type ListQueueMembersInput 

type ListQueueMembersInput struct {

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

	// The queue ID to include on the list.
	//
	// This member is required.
	QueueId *string

	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	MaxResults *int32

	// The token for the next set of results, or null to start from the beginning.
	NextToken *string
	// contains filtered or unexported fields
}

type ListQueueMembersOutput 

type ListQueueMembersOutput struct {

	// The members on the list.
	//
	// This member is required.
	Members []types.QueueMember

	// If Deadline Cloud returns nextToken , then there are more results available. The
	// value of nextToken is a unique pagination token for each page. To retrieve the
	// next page, call the operation again using the returned token. Keep all other
	// arguments unchanged. If no results remain, then nextToken is set to null . Each
	// pagination token expires after 24 hours. If you provide a token that isn't
	// valid, then you receive an HTTP 400 ValidationException error.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListQueueMembersPaginator 

type ListQueueMembersPaginator struct {
	// contains filtered or unexported fields
}

ListQueueMembersPaginator is a paginator for ListQueueMembers

func NewListQueueMembersPaginator 

func NewListQueueMembersPaginator(client ListQueueMembersAPIClient, params *ListQueueMembersInput, optFns ...func(*ListQueueMembersPaginatorOptions)) *ListQueueMembersPaginator

NewListQueueMembersPaginator returns a new ListQueueMembersPaginator

func (*ListQueueMembersPaginator) HasMorePages 

func (p *ListQueueMembersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListQueueMembersPaginator) NextPage 

func (p *ListQueueMembersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListQueueMembersOutput, error)

NextPage retrieves the next ListQueueMembers page.

type ListQueueMembersPaginatorOptions 

type ListQueueMembersPaginatorOptions struct {
	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListQueueMembersPaginatorOptions is the paginator options for ListQueueMembers

type ListQueuesAPIClient 

type ListQueuesAPIClient interface {
	ListQueues(context.Context, *ListQueuesInput, ...func(*Options)) (*ListQueuesOutput, error)
}

ListQueuesAPIClient is a client that implements the ListQueues operation.

type ListQueuesInput 

type ListQueuesInput struct {

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

	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	MaxResults *int32

	// The token for the next set of results, or null to start from the beginning.
	NextToken *string

	// The principal IDs to include in the list of queues.
	PrincipalId *string

	// The status of the queues listed.
	//
	//   - ACTIVE –The queues are active.
	//
	//   - SCHEDULING –The queues are scheduling.
	//
	//   - SCHEDULING_BLOCKED –The queue scheduling is blocked for these queues.
	Status types.QueueStatus
	// contains filtered or unexported fields
}

type ListQueuesOutput 

type ListQueuesOutput struct {

	// The queues on the list.
	//
	// This member is required.
	Queues []types.QueueSummary

	// If Deadline Cloud returns nextToken , then there are more results available. The
	// value of nextToken is a unique pagination token for each page. To retrieve the
	// next page, call the operation again using the returned token. Keep all other
	// arguments unchanged. If no results remain, then nextToken is set to null . Each
	// pagination token expires after 24 hours. If you provide a token that isn't
	// valid, then you receive an HTTP 400 ValidationException error.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListQueuesPaginator 

type ListQueuesPaginator struct {
	// contains filtered or unexported fields
}

ListQueuesPaginator is a paginator for ListQueues

func NewListQueuesPaginator 

func NewListQueuesPaginator(client ListQueuesAPIClient, params *ListQueuesInput, optFns ...func(*ListQueuesPaginatorOptions)) *ListQueuesPaginator

NewListQueuesPaginator returns a new ListQueuesPaginator

func (*ListQueuesPaginator) HasMorePages 

func (p *ListQueuesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListQueuesPaginator) NextPage 

func (p *ListQueuesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListQueuesOutput, error)

NextPage retrieves the next ListQueues page.

type ListQueuesPaginatorOptions 

type ListQueuesPaginatorOptions struct {
	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListQueuesPaginatorOptions is the paginator options for ListQueues

type ListSessionActionsAPIClient 

type ListSessionActionsAPIClient interface {
	ListSessionActions(context.Context, *ListSessionActionsInput, ...func(*Options)) (*ListSessionActionsOutput, error)
}

ListSessionActionsAPIClient is a client that implements the ListSessionActions operation.

type ListSessionActionsInput 

type ListSessionActionsInput struct {

	// The farm ID for the session actions list.
	//
	// This member is required.
	FarmId *string

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

	// The queue ID for the session actions list.
	//
	// This member is required.
	QueueId *string

	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	MaxResults *int32

	// The token for the next set of results, or null to start from the beginning.
	NextToken *string

	// The session ID to include on the sessions action list.
	SessionId *string

	// The task ID for the session actions list.
	TaskId *string
	// contains filtered or unexported fields
}

type ListSessionActionsOutput 

type ListSessionActionsOutput struct {

	// The session actions.
	//
	// This member is required.
	SessionActions []types.SessionActionSummary

	// If Deadline Cloud returns nextToken , then there are more results available. The
	// value of nextToken is a unique pagination token for each page. To retrieve the
	// next page, call the operation again using the returned token. Keep all other
	// arguments unchanged. If no results remain, then nextToken is set to null . Each
	// pagination token expires after 24 hours. If you provide a token that isn't
	// valid, then you receive an HTTP 400 ValidationException error.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListSessionActionsPaginator 

type ListSessionActionsPaginator struct {
	// contains filtered or unexported fields
}

ListSessionActionsPaginator is a paginator for ListSessionActions

func NewListSessionActionsPaginator 

func NewListSessionActionsPaginator(client ListSessionActionsAPIClient, params *ListSessionActionsInput, optFns ...func(*ListSessionActionsPaginatorOptions)) *ListSessionActionsPaginator

NewListSessionActionsPaginator returns a new ListSessionActionsPaginator

func (*ListSessionActionsPaginator) HasMorePages 

func (p *ListSessionActionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSessionActionsPaginator) NextPage 

func (p *ListSessionActionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSessionActionsOutput, error)

NextPage retrieves the next ListSessionActions page.

type ListSessionActionsPaginatorOptions 

type ListSessionActionsPaginatorOptions struct {
	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListSessionActionsPaginatorOptions is the paginator options for ListSessionActions

type ListSessionsAPIClient 

type ListSessionsAPIClient interface {
	ListSessions(context.Context, *ListSessionsInput, ...func(*Options)) (*ListSessionsOutput, error)
}

ListSessionsAPIClient is a client that implements the ListSessions operation.

type ListSessionsForWorkerAPIClient 

type ListSessionsForWorkerAPIClient interface {
	ListSessionsForWorker(context.Context, *ListSessionsForWorkerInput, ...func(*Options)) (*ListSessionsForWorkerOutput, error)
}

ListSessionsForWorkerAPIClient is a client that implements the ListSessionsForWorker operation.

type ListSessionsForWorkerInput 

type ListSessionsForWorkerInput struct {

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

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

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

	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	MaxResults *int32

	// The token for the next set of results, or null to start from the beginning.
	NextToken *string
	// contains filtered or unexported fields
}

type ListSessionsForWorkerOutput 

type ListSessionsForWorkerOutput struct {

	// The sessions in the response.
	//
	// This member is required.
	Sessions []types.WorkerSessionSummary

	// The token for the next set of results, or null to start from the beginning.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListSessionsForWorkerPaginator 

type ListSessionsForWorkerPaginator struct {
	// contains filtered or unexported fields
}

ListSessionsForWorkerPaginator is a paginator for ListSessionsForWorker

func NewListSessionsForWorkerPaginator 

func NewListSessionsForWorkerPaginator(client ListSessionsForWorkerAPIClient, params *ListSessionsForWorkerInput, optFns ...func(*ListSessionsForWorkerPaginatorOptions)) *ListSessionsForWorkerPaginator

NewListSessionsForWorkerPaginator returns a new ListSessionsForWorkerPaginator

func (*ListSessionsForWorkerPaginator) HasMorePages 

func (p *ListSessionsForWorkerPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSessionsForWorkerPaginator) NextPage 

func (p *ListSessionsForWorkerPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSessionsForWorkerOutput, error)

NextPage retrieves the next ListSessionsForWorker page.

type ListSessionsForWorkerPaginatorOptions 

type ListSessionsForWorkerPaginatorOptions struct {
	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListSessionsForWorkerPaginatorOptions is the paginator options for ListSessionsForWorker

type ListSessionsInput 

type ListSessionsInput struct {

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

	// The job ID for the list of sessions.
	//
	// This member is required.
	JobId *string

	// The queue ID for the list of sessions
	//
	// This member is required.
	QueueId *string

	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	MaxResults *int32

	// The token for the next set of results, or null to start from the beginning.
	NextToken *string
	// contains filtered or unexported fields
}

type ListSessionsOutput 

type ListSessionsOutput struct {

	// The sessions on the list.
	//
	// This member is required.
	Sessions []types.SessionSummary

	// If Deadline Cloud returns nextToken , then there are more results available. The
	// value of nextToken is a unique pagination token for each page. To retrieve the
	// next page, call the operation again using the returned token. Keep all other
	// arguments unchanged. If no results remain, then nextToken is set to null . Each
	// pagination token expires after 24 hours. If you provide a token that isn't
	// valid, then you receive an HTTP 400 ValidationException error.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListSessionsPaginator 

type ListSessionsPaginator struct {
	// contains filtered or unexported fields
}

ListSessionsPaginator is a paginator for ListSessions

func NewListSessionsPaginator 

func NewListSessionsPaginator(client ListSessionsAPIClient, params *ListSessionsInput, optFns ...func(*ListSessionsPaginatorOptions)) *ListSessionsPaginator

NewListSessionsPaginator returns a new ListSessionsPaginator

func (*ListSessionsPaginator) HasMorePages 

func (p *ListSessionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSessionsPaginator) NextPage 

func (p *ListSessionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSessionsOutput, error)

NextPage retrieves the next ListSessions page.

type ListSessionsPaginatorOptions 

type ListSessionsPaginatorOptions struct {
	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListSessionsPaginatorOptions is the paginator options for ListSessions

type ListStepConsumersAPIClient 

type ListStepConsumersAPIClient interface {
	ListStepConsumers(context.Context, *ListStepConsumersInput, ...func(*Options)) (*ListStepConsumersOutput, error)
}

ListStepConsumersAPIClient is a client that implements the ListStepConsumers operation.

type ListStepConsumersInput 

type ListStepConsumersInput struct {

	// The farm ID for the list of step consumers.
	//
	// This member is required.
	FarmId *string

	// The job ID for the step consumer.
	//
	// This member is required.
	JobId *string

	// The queue ID for the step consumer.
	//
	// This member is required.
	QueueId *string

	// The step ID to include on the list.
	//
	// This member is required.
	StepId *string

	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	MaxResults *int32

	// The token for the next set of results, or null to start from the beginning.
	NextToken *string
	// contains filtered or unexported fields
}

type ListStepConsumersOutput 

type ListStepConsumersOutput struct {

	// The consumers on the list.
	//
	// This member is required.
	Consumers []types.StepConsumer

	// If Deadline Cloud returns nextToken , then there are more results available. The
	// value of nextToken is a unique pagination token for each page. To retrieve the
	// next page, call the operation again using the returned token. Keep all other
	// arguments unchanged. If no results remain, then nextToken is set to null . Each
	// pagination token expires after 24 hours. If you provide a token that isn't
	// valid, then you receive an HTTP 400 ValidationException error.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListStepConsumersPaginator 

type ListStepConsumersPaginator struct {
	// contains filtered or unexported fields
}

ListStepConsumersPaginator is a paginator for ListStepConsumers

func NewListStepConsumersPaginator 

func NewListStepConsumersPaginator(client ListStepConsumersAPIClient, params *ListStepConsumersInput, optFns ...func(*ListStepConsumersPaginatorOptions)) *ListStepConsumersPaginator

NewListStepConsumersPaginator returns a new ListStepConsumersPaginator

func (*ListStepConsumersPaginator) HasMorePages 

func (p *ListStepConsumersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListStepConsumersPaginator) NextPage 

func (p *ListStepConsumersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListStepConsumersOutput, error)

NextPage retrieves the next ListStepConsumers page.

type ListStepConsumersPaginatorOptions 

type ListStepConsumersPaginatorOptions struct {
	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListStepConsumersPaginatorOptions is the paginator options for ListStepConsumers

type ListStepDependenciesAPIClient 

type ListStepDependenciesAPIClient interface {
	ListStepDependencies(context.Context, *ListStepDependenciesInput, ...func(*Options)) (*ListStepDependenciesOutput, error)
}

ListStepDependenciesAPIClient is a client that implements the ListStepDependencies operation.

type ListStepDependenciesInput 

type ListStepDependenciesInput struct {

	// The farm ID for the step dependencies list.
	//
	// This member is required.
	FarmId *string

	// The job ID for the step dependencies list.
	//
	// This member is required.
	JobId *string

	// The queue ID for the step dependencies list.
	//
	// This member is required.
	QueueId *string

	// The step ID to include on the list.
	//
	// This member is required.
	StepId *string

	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	MaxResults *int32

	// The token for the next set of results, or null to start from the beginning.
	NextToken *string
	// contains filtered or unexported fields
}

type ListStepDependenciesOutput 

type ListStepDependenciesOutput struct {

	// The dependencies on the list.
	//
	// This member is required.
	Dependencies []types.StepDependency

	// If Deadline Cloud returns nextToken , then there are more results available. The
	// value of nextToken is a unique pagination token for each page. To retrieve the
	// next page, call the operation again using the returned token. Keep all other
	// arguments unchanged. If no results remain, then nextToken is set to null . Each
	// pagination token expires after 24 hours. If you provide a token that isn't
	// valid, then you receive an HTTP 400 ValidationException error.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListStepDependenciesPaginator 

type ListStepDependenciesPaginator struct {
	// contains filtered or unexported fields
}

ListStepDependenciesPaginator is a paginator for ListStepDependencies

func NewListStepDependenciesPaginator 

func NewListStepDependenciesPaginator(client ListStepDependenciesAPIClient, params *ListStepDependenciesInput, optFns ...func(*ListStepDependenciesPaginatorOptions)) *ListStepDependenciesPaginator

NewListStepDependenciesPaginator returns a new ListStepDependenciesPaginator

func (*ListStepDependenciesPaginator) HasMorePages 

func (p *ListStepDependenciesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListStepDependenciesPaginator) NextPage 

func (p *ListStepDependenciesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListStepDependenciesOutput, error)

NextPage retrieves the next ListStepDependencies page.

type ListStepDependenciesPaginatorOptions 

type ListStepDependenciesPaginatorOptions struct {
	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListStepDependenciesPaginatorOptions is the paginator options for ListStepDependencies

type ListStepsAPIClient 

type ListStepsAPIClient interface {
	ListSteps(context.Context, *ListStepsInput, ...func(*Options)) (*ListStepsOutput, error)
}

ListStepsAPIClient is a client that implements the ListSteps operation.

type ListStepsInput 

type ListStepsInput struct {

	// The farm ID to include on the list of steps.
	//
	// This member is required.
	FarmId *string

	// The job ID to include on the list of steps.
	//
	// This member is required.
	JobId *string

	// The queue ID to include on the list of steps.
	//
	// This member is required.
	QueueId *string

	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	MaxResults *int32

	// The token for the next set of results, or null to start from the beginning.
	NextToken *string
	// contains filtered or unexported fields
}

type ListStepsOutput 

type ListStepsOutput struct {

	// The steps on the list.
	//
	// This member is required.
	Steps []types.StepSummary

	// If Deadline Cloud returns nextToken , then there are more results available. The
	// value of nextToken is a unique pagination token for each page. To retrieve the
	// next page, call the operation again using the returned token. Keep all other
	// arguments unchanged. If no results remain, then nextToken is set to null . Each
	// pagination token expires after 24 hours. If you provide a token that isn't
	// valid, then you receive an HTTP 400 ValidationException error.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListStepsPaginator 

type ListStepsPaginator struct {
	// contains filtered or unexported fields
}

ListStepsPaginator is a paginator for ListSteps

func NewListStepsPaginator 

func NewListStepsPaginator(client ListStepsAPIClient, params *ListStepsInput, optFns ...func(*ListStepsPaginatorOptions)) *ListStepsPaginator

NewListStepsPaginator returns a new ListStepsPaginator

func (*ListStepsPaginator) HasMorePages 

func (p *ListStepsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListStepsPaginator) NextPage 

func (p *ListStepsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListStepsOutput, error)

NextPage retrieves the next ListSteps page.

type ListStepsPaginatorOptions 

type ListStepsPaginatorOptions struct {
	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListStepsPaginatorOptions is the paginator options for ListSteps

type ListStorageProfilesAPIClient 

type ListStorageProfilesAPIClient interface {
	ListStorageProfiles(context.Context, *ListStorageProfilesInput, ...func(*Options)) (*ListStorageProfilesOutput, error)
}

ListStorageProfilesAPIClient is a client that implements the ListStorageProfiles operation.

type ListStorageProfilesForQueueAPIClient 

type ListStorageProfilesForQueueAPIClient interface {
	ListStorageProfilesForQueue(context.Context, *ListStorageProfilesForQueueInput, ...func(*Options)) (*ListStorageProfilesForQueueOutput, error)
}

ListStorageProfilesForQueueAPIClient is a client that implements the ListStorageProfilesForQueue operation.

type ListStorageProfilesForQueueInput 

type ListStorageProfilesForQueueInput struct {

	// The farm ID of the queue's storage profile.
	//
	// This member is required.
	FarmId *string

	// The queue ID for the storage profile.
	//
	// This member is required.
	QueueId *string

	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	MaxResults *int32

	// The token for the next set of results, or null to start from the beginning.
	NextToken *string
	// contains filtered or unexported fields
}

type ListStorageProfilesForQueueOutput 

type ListStorageProfilesForQueueOutput struct {

	// The storage profiles in the queue.
	//
	// This member is required.
	StorageProfiles []types.StorageProfileSummary

	// If Deadline Cloud returns nextToken , then there are more results available. The
	// value of nextToken is a unique pagination token for each page. To retrieve the
	// next page, call the operation again using the returned token. Keep all other
	// arguments unchanged. If no results remain, then nextToken is set to null . Each
	// pagination token expires after 24 hours. If you provide a token that isn't
	// valid, then you receive an HTTP 400 ValidationException error.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListStorageProfilesForQueuePaginator 

type ListStorageProfilesForQueuePaginator struct {
	// contains filtered or unexported fields
}

ListStorageProfilesForQueuePaginator is a paginator for ListStorageProfilesForQueue

func NewListStorageProfilesForQueuePaginator 

func NewListStorageProfilesForQueuePaginator(client ListStorageProfilesForQueueAPIClient, params *ListStorageProfilesForQueueInput, optFns ...func(*ListStorageProfilesForQueuePaginatorOptions)) *ListStorageProfilesForQueuePaginator

NewListStorageProfilesForQueuePaginator returns a new ListStorageProfilesForQueuePaginator

func (*ListStorageProfilesForQueuePaginator) HasMorePages 

func (p *ListStorageProfilesForQueuePaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListStorageProfilesForQueuePaginator) NextPage 

func (p *ListStorageProfilesForQueuePaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListStorageProfilesForQueueOutput, error)

NextPage retrieves the next ListStorageProfilesForQueue page.

type ListStorageProfilesForQueuePaginatorOptions 

type ListStorageProfilesForQueuePaginatorOptions struct {
	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListStorageProfilesForQueuePaginatorOptions is the paginator options for ListStorageProfilesForQueue

type ListStorageProfilesInput 

type ListStorageProfilesInput struct {

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

	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	MaxResults *int32

	// The token for the next set of results, or null to start from the beginning.
	NextToken *string
	// contains filtered or unexported fields
}

type ListStorageProfilesOutput 

type ListStorageProfilesOutput struct {

	// The storage profiles.
	//
	// This member is required.
	StorageProfiles []types.StorageProfileSummary

	// If Deadline Cloud returns nextToken , then there are more results available. The
	// value of nextToken is a unique pagination token for each page. To retrieve the
	// next page, call the operation again using the returned token. Keep all other
	// arguments unchanged. If no results remain, then nextToken is set to null . Each
	// pagination token expires after 24 hours. If you provide a token that isn't
	// valid, then you receive an HTTP 400 ValidationException error.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListStorageProfilesPaginator 

type ListStorageProfilesPaginator struct {
	// contains filtered or unexported fields
}

ListStorageProfilesPaginator is a paginator for ListStorageProfiles

func NewListStorageProfilesPaginator 

func NewListStorageProfilesPaginator(client ListStorageProfilesAPIClient, params *ListStorageProfilesInput, optFns ...func(*ListStorageProfilesPaginatorOptions)) *ListStorageProfilesPaginator

NewListStorageProfilesPaginator returns a new ListStorageProfilesPaginator

func (*ListStorageProfilesPaginator) HasMorePages 

func (p *ListStorageProfilesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListStorageProfilesPaginator) NextPage 

func (p *ListStorageProfilesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListStorageProfilesOutput, error)

NextPage retrieves the next ListStorageProfiles page.

type ListStorageProfilesPaginatorOptions 

type ListStorageProfilesPaginatorOptions struct {
	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListStorageProfilesPaginatorOptions is the paginator options for ListStorageProfiles

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The resource ARN to list tags for.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// Each tag consists of a tag key and a tag value. Tag keys and values are both
	// required, but tag values can be empty strings.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListTasksAPIClient 

type ListTasksAPIClient interface {
	ListTasks(context.Context, *ListTasksInput, ...func(*Options)) (*ListTasksOutput, error)
}

ListTasksAPIClient is a client that implements the ListTasks operation.

type ListTasksInput 

type ListTasksInput struct {

	// The farm ID connected to the tasks.
	//
	// This member is required.
	FarmId *string

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

	// The queue ID connected to the tasks.
	//
	// This member is required.
	QueueId *string

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

	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	MaxResults *int32

	// The token for the next set of results, or null to start from the beginning.
	NextToken *string
	// contains filtered or unexported fields
}

type ListTasksOutput 

type ListTasksOutput struct {

	// Tasks for the job.
	//
	// This member is required.
	Tasks []types.TaskSummary

	// If Deadline Cloud returns nextToken , then there are more results available. The
	// value of nextToken is a unique pagination token for each page. To retrieve the
	// next page, call the operation again using the returned token. Keep all other
	// arguments unchanged. If no results remain, then nextToken is set to null . Each
	// pagination token expires after 24 hours. If you provide a token that isn't
	// valid, then you receive an HTTP 400 ValidationException error.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListTasksPaginator 

type ListTasksPaginator struct {
	// contains filtered or unexported fields
}

ListTasksPaginator is a paginator for ListTasks

func NewListTasksPaginator 

func NewListTasksPaginator(client ListTasksAPIClient, params *ListTasksInput, optFns ...func(*ListTasksPaginatorOptions)) *ListTasksPaginator

NewListTasksPaginator returns a new ListTasksPaginator

func (*ListTasksPaginator) HasMorePages 

func (p *ListTasksPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTasksPaginator) NextPage 

func (p *ListTasksPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTasksOutput, error)

NextPage retrieves the next ListTasks page.

type ListTasksPaginatorOptions 

type ListTasksPaginatorOptions struct {
	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListTasksPaginatorOptions is the paginator options for ListTasks

type ListWorkersAPIClient 

type ListWorkersAPIClient interface {
	ListWorkers(context.Context, *ListWorkersInput, ...func(*Options)) (*ListWorkersOutput, error)
}

ListWorkersAPIClient is a client that implements the ListWorkers operation.

type ListWorkersInput 

type ListWorkersInput struct {

	// The farm ID connected to the workers.
	//
	// This member is required.
	FarmId *string

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

	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	MaxResults *int32

	// The token for the next set of results, or null to start from the beginning.
	NextToken *string
	// contains filtered or unexported fields
}

type ListWorkersOutput 

type ListWorkersOutput struct {

	// The workers on the list.
	//
	// This member is required.
	Workers []types.WorkerSummary

	// If Deadline Cloud returns nextToken , then there are more results available. The
	// value of nextToken is a unique pagination token for each page. To retrieve the
	// next page, call the operation again using the returned token. Keep all other
	// arguments unchanged. If no results remain, then nextToken is set to null . Each
	// pagination token expires after 24 hours. If you provide a token that isn't
	// valid, then you receive an HTTP 400 ValidationException error.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListWorkersPaginator 

type ListWorkersPaginator struct {
	// contains filtered or unexported fields
}

ListWorkersPaginator is a paginator for ListWorkers

func NewListWorkersPaginator 

func NewListWorkersPaginator(client ListWorkersAPIClient, params *ListWorkersInput, optFns ...func(*ListWorkersPaginatorOptions)) *ListWorkersPaginator

NewListWorkersPaginator returns a new ListWorkersPaginator

func (*ListWorkersPaginator) HasMorePages 

func (p *ListWorkersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListWorkersPaginator) NextPage 

func (p *ListWorkersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListWorkersOutput, error)

NextPage retrieves the next ListWorkers page.

type ListWorkersPaginatorOptions 

type ListWorkersPaginatorOptions struct {
	// The maximum number of results to return. Use this parameter with NextToken to
	// get results as a set of sequential pages.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListWorkersPaginatorOptions is the paginator options for ListWorkers

type Options 

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint.
	//
	// To migrate an EndpointResolver implementation that uses a custom endpoint, set
	// the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// Provides idempotency tokens values that will be automatically populated into
	// idempotent API operations.
	IdempotencyTokenProvider IdempotencyTokenProvider

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The client meter provider.
	MeterProvider metrics.MeterProvider

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts.
	//
	// If specified in an operation call's functional options with a value that is
	// different than the constructed client's Options, the Client's Retryer will be
	// wrapped to use the operation's specific RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified.
	//
	// When creating a new API Clients this member will only be used if the Retryer
	// Options member is nil. This value will be ignored if Retryer is not nil.
	//
	// Currently does not support per operation call overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The client tracer provider.
	TracerProvider tracing.TracerProvider

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetIdentityResolver 

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type PutMeteredProductInput 

type PutMeteredProductInput struct {

	// The license endpoint ID to add to the metered product.
	//
	// This member is required.
	LicenseEndpointId *string

	// The product ID to add to the metered product.
	//
	// This member is required.
	ProductId *string
	// contains filtered or unexported fields
}

type PutMeteredProductOutput 

type PutMeteredProductOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type QueueFleetAssociationStoppedWaiter 

type QueueFleetAssociationStoppedWaiter struct {
	// contains filtered or unexported fields
}

QueueFleetAssociationStoppedWaiter defines the waiters for QueueFleetAssociationStopped

func NewQueueFleetAssociationStoppedWaiter 

func NewQueueFleetAssociationStoppedWaiter(client GetQueueFleetAssociationAPIClient, optFns ...func(*QueueFleetAssociationStoppedWaiterOptions)) *QueueFleetAssociationStoppedWaiter

NewQueueFleetAssociationStoppedWaiter constructs a QueueFleetAssociationStoppedWaiter.

func (*QueueFleetAssociationStoppedWaiter) Wait 

func (w *QueueFleetAssociationStoppedWaiter) Wait(ctx context.Context, params *GetQueueFleetAssociationInput, maxWaitDur time.Duration, optFns ...func(*QueueFleetAssociationStoppedWaiterOptions)) error

Wait calls the waiter function for QueueFleetAssociationStopped waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*QueueFleetAssociationStoppedWaiter) WaitForOutput 

func (w *QueueFleetAssociationStoppedWaiter) WaitForOutput(ctx context.Context, params *GetQueueFleetAssociationInput, maxWaitDur time.Duration, optFns ...func(*QueueFleetAssociationStoppedWaiterOptions)) (*GetQueueFleetAssociationOutput, error)

WaitForOutput calls the waiter function for QueueFleetAssociationStopped waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type QueueFleetAssociationStoppedWaiterOptions 

type QueueFleetAssociationStoppedWaiterOptions struct {

	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// QueueFleetAssociationStoppedWaiter will use default minimum delay of 10 seconds.
	// Note that MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, QueueFleetAssociationStoppedWaiter will use default max delay of
	// 600 seconds. Note that MaxDelay must resolve to value greater than or equal to
	// the MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state.
	//
	// By default service-modeled logic will populate this option. This option can
	// thus be used to define a custom waiter state with fall-back to service-modeled
	// waiter state mutators.The function returns an error in case of a failure state.
	// In case of retry state, this function returns a bool value of true and nil
	// error, while in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *GetQueueFleetAssociationInput, *GetQueueFleetAssociationOutput, error) (bool, error)
}

QueueFleetAssociationStoppedWaiterOptions are waiter options for QueueFleetAssociationStoppedWaiter

type QueueSchedulingBlockedWaiter 

type QueueSchedulingBlockedWaiter struct {
	// contains filtered or unexported fields
}

QueueSchedulingBlockedWaiter defines the waiters for QueueSchedulingBlocked

func NewQueueSchedulingBlockedWaiter 

func NewQueueSchedulingBlockedWaiter(client GetQueueAPIClient, optFns ...func(*QueueSchedulingBlockedWaiterOptions)) *QueueSchedulingBlockedWaiter

NewQueueSchedulingBlockedWaiter constructs a QueueSchedulingBlockedWaiter.

func (*QueueSchedulingBlockedWaiter) Wait 

func (w *QueueSchedulingBlockedWaiter) Wait(ctx context.Context, params *GetQueueInput, maxWaitDur time.Duration, optFns ...func(*QueueSchedulingBlockedWaiterOptions)) error

Wait calls the waiter function for QueueSchedulingBlocked waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*QueueSchedulingBlockedWaiter) WaitForOutput 

func (w *QueueSchedulingBlockedWaiter) WaitForOutput(ctx context.Context, params *GetQueueInput, maxWaitDur time.Duration, optFns ...func(*QueueSchedulingBlockedWaiterOptions)) (*GetQueueOutput, error)

WaitForOutput calls the waiter function for QueueSchedulingBlocked waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type QueueSchedulingBlockedWaiterOptions 

type QueueSchedulingBlockedWaiterOptions struct {

	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// QueueSchedulingBlockedWaiter will use default minimum delay of 10 seconds. Note
	// that MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, QueueSchedulingBlockedWaiter will use default max delay of 300
	// seconds. Note that MaxDelay must resolve to value greater than or equal to the
	// MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state.
	//
	// By default service-modeled logic will populate this option. This option can
	// thus be used to define a custom waiter state with fall-back to service-modeled
	// waiter state mutators.The function returns an error in case of a failure state.
	// In case of retry state, this function returns a bool value of true and nil
	// error, while in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *GetQueueInput, *GetQueueOutput, error) (bool, error)
}

QueueSchedulingBlockedWaiterOptions are waiter options for QueueSchedulingBlockedWaiter

type QueueSchedulingWaiter 

type QueueSchedulingWaiter struct {
	// contains filtered or unexported fields
}

QueueSchedulingWaiter defines the waiters for QueueScheduling

func NewQueueSchedulingWaiter 

func NewQueueSchedulingWaiter(client GetQueueAPIClient, optFns ...func(*QueueSchedulingWaiterOptions)) *QueueSchedulingWaiter

NewQueueSchedulingWaiter constructs a QueueSchedulingWaiter.

func (*QueueSchedulingWaiter) Wait 

func (w *QueueSchedulingWaiter) Wait(ctx context.Context, params *GetQueueInput, maxWaitDur time.Duration, optFns ...func(*QueueSchedulingWaiterOptions)) error

Wait calls the waiter function for QueueScheduling waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*QueueSchedulingWaiter) WaitForOutput 

func (w *QueueSchedulingWaiter) WaitForOutput(ctx context.Context, params *GetQueueInput, maxWaitDur time.Duration, optFns ...func(*QueueSchedulingWaiterOptions)) (*GetQueueOutput, error)

WaitForOutput calls the waiter function for QueueScheduling waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type QueueSchedulingWaiterOptions 

type QueueSchedulingWaiterOptions struct {

	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// QueueSchedulingWaiter will use default minimum delay of 10 seconds. Note that
	// MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, QueueSchedulingWaiter will use default max delay of 700 seconds.
	// Note that MaxDelay must resolve to value greater than or equal to the MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state.
	//
	// By default service-modeled logic will populate this option. This option can
	// thus be used to define a custom waiter state with fall-back to service-modeled
	// waiter state mutators.The function returns an error in case of a failure state.
	// In case of retry state, this function returns a bool value of true and nil
	// error, while in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *GetQueueInput, *GetQueueOutput, error) (bool, error)
}

QueueSchedulingWaiterOptions are waiter options for QueueSchedulingWaiter

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type SearchJobsInput 

type SearchJobsInput struct {

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

	// Defines how far into the scrollable list to start the return of results.
	//
	// This member is required.
	ItemOffset *int32

	// The queue ID to use in the job search.
	//
	// This member is required.
	QueueIds []string

	// 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 () .
	FilterExpressions *types.SearchGroupedFilterExpressions

	// Specifies the number of items per page for the resource.
	PageSize *int32

	// The search terms for a resource.
	SortExpressions []types.SearchSortExpression
	// contains filtered or unexported fields
}

type SearchJobsOutput 

type SearchJobsOutput struct {

	// The jobs in the search.
	//
	// This member is required.
	Jobs []types.JobSearchSummary

	// The total number of results in the search.
	//
	// This member is required.
	TotalResults *int32

	// The next incremental starting point after the defined itemOffset .
	NextItemOffset *int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type SearchStepsInput 

type SearchStepsInput struct {

	// The farm ID to use for the step search.
	//
	// This member is required.
	FarmId *string

	// Defines how far into the scrollable list to start the return of results.
	//
	// This member is required.
	ItemOffset *int32

	// The queue IDs in the step search.
	//
	// This member is required.
	QueueIds []string

	// 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 () .
	FilterExpressions *types.SearchGroupedFilterExpressions

	// The job ID to use in the step search.
	JobId *string

	// Specifies the number of items per page for the resource.
	PageSize *int32

	// The search terms for a resource.
	SortExpressions []types.SearchSortExpression
	// contains filtered or unexported fields
}

type SearchStepsOutput 

type SearchStepsOutput struct {

	// The steps in the search.
	//
	// This member is required.
	Steps []types.StepSearchSummary

	// The total number of results in the search.
	//
	// This member is required.
	TotalResults *int32

	// The next incremental starting point after the defined itemOffset .
	NextItemOffset *int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type SearchTasksInput 

type SearchTasksInput struct {

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

	// Defines how far into the scrollable list to start the return of results.
	//
	// This member is required.
	ItemOffset *int32

	// The queue IDs to include in the search.
	//
	// This member is required.
	QueueIds []string

	// 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 () .
	FilterExpressions *types.SearchGroupedFilterExpressions

	// The job ID for the task search.
	JobId *string

	// Specifies the number of items per page for the resource.
	PageSize *int32

	// The search terms for a resource.
	SortExpressions []types.SearchSortExpression
	// contains filtered or unexported fields
}

type SearchTasksOutput 

type SearchTasksOutput struct {

	// Tasks in the search.
	//
	// This member is required.
	Tasks []types.TaskSearchSummary

	// The total number of results in the search.
	//
	// This member is required.
	TotalResults *int32

	// The next incremental starting point after the defined itemOffset .
	NextItemOffset *int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type SearchWorkersInput 

type SearchWorkersInput struct {

	// The farm ID in the workers search.
	//
	// This member is required.
	FarmId *string

	// The fleet ID of the workers to search for.
	//
	// This member is required.
	FleetIds []string

	// Defines how far into the scrollable list to start the return of results.
	//
	// This member is required.
	ItemOffset *int32

	// 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 () .
	FilterExpressions *types.SearchGroupedFilterExpressions

	// Specifies the number of items per page for the resource.
	PageSize *int32

	// The search terms for a resource.
	SortExpressions []types.SearchSortExpression
	// contains filtered or unexported fields
}

type SearchWorkersOutput 

type SearchWorkersOutput struct {

	// The total number of results in the search.
	//
	// This member is required.
	TotalResults *int32

	// The workers for the search.
	//
	// This member is required.
	Workers []types.WorkerSearchSummary

	// The next incremental starting point after the defined itemOffset .
	NextItemOffset *int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartSessionsStatisticsAggregationInput 

type StartSessionsStatisticsAggregationInput struct {

	// The Linux timestamp of the date and time that the statistics end.
	//
	// This member is required.
	EndTime *time.Time

	// The identifier of the farm that contains queues or fleets to return statistics
	// for.
	//
	// This member is required.
	FarmId *string

	// The field to use to group the statistics.
	//
	// This member is required.
	GroupBy []types.UsageGroupByField

	// A list of fleet IDs or queue IDs to gather statistics for.
	//
	// This member is required.
	ResourceIds types.SessionsStatisticsResources

	// The Linux timestamp of the date and time that the statistics start.
	//
	// This member is required.
	StartTime *time.Time

	// One to four statistics to return.
	//
	// This member is required.
	Statistics []types.UsageStatistic

	// The period to aggregate the statistics.
	Period types.Period

	// The timezone to use for the statistics. Use UTC notation such as "UTC+8."
	Timezone *string
	// contains filtered or unexported fields
}

type StartSessionsStatisticsAggregationOutput 

type StartSessionsStatisticsAggregationOutput struct {

	// A unique identifier for the aggregated statistics. Use this identifier with the
	// GetAggregatedStatisticsForSessions operation to return the statistics.
	//
	// This member is required.
	AggregationId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type TagResourceInput 

type TagResourceInput struct {

	// The ARN of the resource to apply tags to.
	//
	// This member is required.
	ResourceArn *string

	// Each tag consists of a tag key and a tag value. Tag keys and values are both
	// required, but tag values can be empty strings.
	Tags map[string]string
	// contains filtered or unexported fields
}

type TagResourceOutput 

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UntagResourceInput 

type UntagResourceInput struct {

	// The ARN of the resource to remove the tag from.
	//
	// This member is required.
	ResourceArn *string

	// They keys of the tag.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput 

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateBudgetInput 

type UpdateBudgetInput struct {

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

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

	// The budget actions to add. Budget actions specify what happens when the budget
	// runs out.
	ActionsToAdd []types.BudgetActionToAdd

	// The budget actions to remove from the budget.
	ActionsToRemove []types.BudgetActionToRemove

	// The dollar limit to update on the budget. Based on consumed usage.
	ApproximateDollarLimit *float32

	// The unique token which the server uses to recognize retries of the same request.
	ClientToken *string

	// The description of the budget 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.
	Description *string

	// The display name of the budget 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.
	DisplayName *string

	// The schedule to update.
	Schedule types.BudgetSchedule

	// Updates 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.
	Status types.BudgetStatus
	// contains filtered or unexported fields
}

type UpdateBudgetOutput 

type UpdateBudgetOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateFarmInput 

type UpdateFarmInput struct {

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

	// The description of the farm 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.
	Description *string

	// The display name of the farm 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.
	DisplayName *string
	// contains filtered or unexported fields
}

type UpdateFarmOutput 

type UpdateFarmOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateFleetInput 

type UpdateFleetInput struct {

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

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

	// The unique token which the server uses to recognize retries of the same request.
	ClientToken *string

	// The fleet configuration to update.
	Configuration types.FleetConfiguration

	// The description of the fleet 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.
	Description *string

	// The display name of the fleet 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.
	DisplayName *string

	// The maximum number of workers in the fleet.
	MaxWorkerCount *int32

	// The minimum number of workers in the fleet.
	MinWorkerCount *int32

	// The IAM role ARN that the fleet's workers assume while running jobs.
	RoleArn *string
	// contains filtered or unexported fields
}

type UpdateFleetOutput 

type UpdateFleetOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateJobInput 

type UpdateJobInput struct {

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

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

	// The queue ID of the job to update.
	//
	// This member is required.
	QueueId *string

	// The unique token which the server uses to recognize retries of the same request.
	ClientToken *string

	// The status of a job in its lifecycle. When you change the status of the job to
	// ARCHIVED , the job can't be scheduled or archived.
	//
	// An archived jobs and its steps and tasks are deleted after 120 days. The job
	// can't be recovered.
	LifecycleStatus types.UpdateJobLifecycleStatus

	// 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 job priority to update.
	Priority *int32

	// The task status to update the job's tasks to.
	TargetTaskRunStatus types.JobTargetTaskRunStatus
	// contains filtered or unexported fields
}

type UpdateJobOutput 

type UpdateJobOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateMonitorInput 

type UpdateMonitorInput struct {

	// The unique identifier of the monitor to update.
	//
	// This member is required.
	MonitorId *string

	// The new value to use for the monitor's display name.
	//
	// 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.
	DisplayName *string

	// The Amazon Resource Name (ARN) of the new IAM role to use with the monitor.
	RoleArn *string

	// The new value of the subdomain to use when forming the monitor URL.
	Subdomain *string
	// contains filtered or unexported fields
}

type UpdateMonitorOutput 

type UpdateMonitorOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateQueueEnvironmentInput 

type UpdateQueueEnvironmentInput struct {

	// The farm ID of the queue environment to update.
	//
	// This member is required.
	FarmId *string

	// The queue environment ID to update.
	//
	// This member is required.
	QueueEnvironmentId *string

	// The queue ID of the queue environment to update.
	//
	// This member is required.
	QueueId *string

	// The unique token which the server uses to recognize retries of the same request.
	ClientToken *string

	// The priority to update.
	Priority *int32

	// The template to update.
	Template *string

	// The template type to update.
	TemplateType types.EnvironmentTemplateType
	// contains filtered or unexported fields
}

type UpdateQueueEnvironmentOutput 

type UpdateQueueEnvironmentOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateQueueFleetAssociationInput 

type UpdateQueueFleetAssociationInput struct {

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

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

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

	// The status to update.
	//
	// This member is required.
	Status types.UpdateQueueFleetAssociationStatus
	// contains filtered or unexported fields
}

type UpdateQueueFleetAssociationOutput 

type UpdateQueueFleetAssociationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateQueueInput 

type UpdateQueueInput struct {

	// The farm ID to update in the queue.
	//
	// This member is required.
	FarmId *string

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

	// The storage profile IDs to add.
	AllowedStorageProfileIdsToAdd []string

	// The storage profile ID to remove.
	AllowedStorageProfileIdsToRemove []string

	// The idempotency token to update in the queue.
	ClientToken *string

	// The default action to take for a queue update if a budget isn't configured.
	DefaultBudgetAction types.DefaultQueueBudgetAction

	// The description of the queue 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.
	Description *string

	// The display name of the queue 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.
	DisplayName *string

	// The job attachment settings to update for the queue.
	JobAttachmentSettings *types.JobAttachmentSettings

	// Update the jobs in the queue to run as a specified POSIX user.
	JobRunAsUser *types.JobRunAsUser

	// The required file system location names to add to the queue.
	RequiredFileSystemLocationNamesToAdd []string

	// The required file system location names to remove from the queue.
	RequiredFileSystemLocationNamesToRemove []string

	// The IAM role ARN that's used to run jobs from this queue.
	RoleArn *string
	// contains filtered or unexported fields
}

type UpdateQueueOutput 

type UpdateQueueOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateSessionInput 

type UpdateSessionInput struct {

	// The farm ID to update in the session.
	//
	// This member is required.
	FarmId *string

	// The job ID to update in the session.
	//
	// This member is required.
	JobId *string

	// The queue ID to update in the session.
	//
	// This member is required.
	QueueId *string

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

	// The life cycle status to update in the session.
	//
	// This member is required.
	TargetLifecycleStatus types.SessionLifecycleTargetStatus

	// The unique token which the server uses to recognize retries of the same request.
	ClientToken *string
	// contains filtered or unexported fields
}

type UpdateSessionOutput 

type UpdateSessionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateStepInput 

type UpdateStepInput struct {

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

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

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

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

	// The task status to update the step's tasks to.
	//
	// This member is required.
	TargetTaskRunStatus types.StepTargetTaskRunStatus

	// The unique token which the server uses to recognize retries of the same request.
	ClientToken *string
	// contains filtered or unexported fields
}

type UpdateStepOutput 

type UpdateStepOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateStorageProfileInput 

type UpdateStorageProfileInput struct {

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

	// The storage profile ID to update.
	//
	// This member is required.
	StorageProfileId *string

	// The unique token which the server uses to recognize retries of the same request.
	ClientToken *string

	// The display name of the storage profile 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.
	DisplayName *string

	// The file system location names to add.
	FileSystemLocationsToAdd []types.FileSystemLocation

	// The file system location names to remove.
	FileSystemLocationsToRemove []types.FileSystemLocation

	// The OS system to update.
	OsFamily types.StorageProfileOperatingSystemFamily
	// contains filtered or unexported fields
}

type UpdateStorageProfileOutput 

type UpdateStorageProfileOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateTaskInput 

type UpdateTaskInput struct {

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

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

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

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

	// The run status with which to start the task.
	//
	// This member is required.
	TargetRunStatus types.TaskTargetRunStatus

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

	// The unique token which the server uses to recognize retries of the same request.
	ClientToken *string
	// contains filtered or unexported fields
}

type UpdateTaskOutput 

type UpdateTaskOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateWorkerInput 

type UpdateWorkerInput struct {

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

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

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

	// The worker capabilities to update.
	Capabilities *types.WorkerCapabilities

	// The host properties to update.
	HostProperties *types.HostPropertiesRequest

	// The worker status to update.
	Status types.UpdatedWorkerStatus
	// contains filtered or unexported fields
}

type UpdateWorkerOutput 

type UpdateWorkerOutput struct {

	// The worker log to update.
	Log *types.LogConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateWorkerScheduleInput 

type UpdateWorkerScheduleInput struct {

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

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

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

	// The session actions associated with the worker schedule to update.
	UpdatedSessionActions map[string]types.UpdatedSessionActionInfo
	// contains filtered or unexported fields
}

type UpdateWorkerScheduleOutput 

type UpdateWorkerScheduleOutput struct {

	// The assigned sessions to update.
	//
	// This member is required.
	AssignedSessions map[string]types.AssignedSession

	// The session actions associated with the worker schedule to cancel.
	//
	// This member is required.
	CancelSessionActions map[string][]string

	// Updates the time interval (in seconds) for the schedule.
	//
	// This member is required.
	UpdateIntervalSeconds *int32

	// The status to update the worker to.
	DesiredWorkerStatus types.DesiredWorkerStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Source Files

View all Source files

Directories

Path Synopsis
Package document implements encoding and decoding of open-content that has a JSON-like data model.
 Package document implements encoding and decoding of open-content that has a JSON-like data model.
internal
document
endpoints

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.