Documentation
¶
Overview ¶
Package batch provides the client and types for making API requests to AWS Batch.
AWS Batch enables you to run batch computing workloads on the AWS Cloud. Batch computing is a common way for developers, scientists, and engineers to access large amounts of compute resources, and AWS Batch removes the undifferentiated heavy lifting of configuring and managing the required infrastructure. AWS Batch will be familiar to users of traditional batch computing software. This service can efficiently provision resources in response to jobs submitted in order to eliminate capacity constraints, reduce compute costs, and deliver results quickly.
As a fully managed service, AWS Batch enables developers, scientists, and engineers to run batch computing workloads of any scale. AWS Batch automatically provisions compute resources and optimizes the workload distribution based on the quantity and scale of the workloads. With AWS Batch, there is no need to install or manage batch computing software, which allows you to focus on analyzing results and solving problems. AWS Batch reduces operational complexities, saves time, and reduces costs, which makes it easy for developers, scientists, and engineers to run their batch jobs in the AWS Cloud.
See https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10 for more information on this service.
See batch package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/batch/
Using the Client ¶
To contact AWS Batch with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.
See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/
See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
See the AWS Batch client Batch for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/batch/#New
Index ¶
- Constants
- type ArrayProperties
- type ArrayPropertiesDetail
- func (s ArrayPropertiesDetail) GoString() string
- func (s *ArrayPropertiesDetail) SetIndex(v int64) *ArrayPropertiesDetail
- func (s *ArrayPropertiesDetail) SetSize(v int64) *ArrayPropertiesDetail
- func (s *ArrayPropertiesDetail) SetStatusSummary(v map[string]*int64) *ArrayPropertiesDetail
- func (s ArrayPropertiesDetail) String() string
- type ArrayPropertiesSummary
- type AttemptContainerDetail
- func (s AttemptContainerDetail) GoString() string
- func (s *AttemptContainerDetail) SetContainerInstanceArn(v string) *AttemptContainerDetail
- func (s *AttemptContainerDetail) SetExitCode(v int64) *AttemptContainerDetail
- func (s *AttemptContainerDetail) SetLogStreamName(v string) *AttemptContainerDetail
- func (s *AttemptContainerDetail) SetReason(v string) *AttemptContainerDetail
- func (s *AttemptContainerDetail) SetTaskArn(v string) *AttemptContainerDetail
- func (s AttemptContainerDetail) String() string
- type AttemptDetail
- func (s AttemptDetail) GoString() string
- func (s *AttemptDetail) SetContainer(v *AttemptContainerDetail) *AttemptDetail
- func (s *AttemptDetail) SetStartedAt(v int64) *AttemptDetail
- func (s *AttemptDetail) SetStatusReason(v string) *AttemptDetail
- func (s *AttemptDetail) SetStoppedAt(v int64) *AttemptDetail
- func (s AttemptDetail) String() string
- type Batch
- func (c *Batch) CancelJob(input *CancelJobInput) (*CancelJobOutput, error)
- func (c *Batch) CancelJobRequest(input *CancelJobInput) (req *request.Request, output *CancelJobOutput)
- func (c *Batch) CancelJobWithContext(ctx aws.Context, input *CancelJobInput, opts ...request.Option) (*CancelJobOutput, error)
- func (c *Batch) CreateComputeEnvironment(input *CreateComputeEnvironmentInput) (*CreateComputeEnvironmentOutput, error)
- func (c *Batch) CreateComputeEnvironmentRequest(input *CreateComputeEnvironmentInput) (req *request.Request, output *CreateComputeEnvironmentOutput)
- func (c *Batch) CreateComputeEnvironmentWithContext(ctx aws.Context, input *CreateComputeEnvironmentInput, opts ...request.Option) (*CreateComputeEnvironmentOutput, error)
- func (c *Batch) CreateJobQueue(input *CreateJobQueueInput) (*CreateJobQueueOutput, error)
- func (c *Batch) CreateJobQueueRequest(input *CreateJobQueueInput) (req *request.Request, output *CreateJobQueueOutput)
- func (c *Batch) CreateJobQueueWithContext(ctx aws.Context, input *CreateJobQueueInput, opts ...request.Option) (*CreateJobQueueOutput, error)
- func (c *Batch) DeleteComputeEnvironment(input *DeleteComputeEnvironmentInput) (*DeleteComputeEnvironmentOutput, error)
- func (c *Batch) DeleteComputeEnvironmentRequest(input *DeleteComputeEnvironmentInput) (req *request.Request, output *DeleteComputeEnvironmentOutput)
- func (c *Batch) DeleteComputeEnvironmentWithContext(ctx aws.Context, input *DeleteComputeEnvironmentInput, opts ...request.Option) (*DeleteComputeEnvironmentOutput, error)
- func (c *Batch) DeleteJobQueue(input *DeleteJobQueueInput) (*DeleteJobQueueOutput, error)
- func (c *Batch) DeleteJobQueueRequest(input *DeleteJobQueueInput) (req *request.Request, output *DeleteJobQueueOutput)
- func (c *Batch) DeleteJobQueueWithContext(ctx aws.Context, input *DeleteJobQueueInput, opts ...request.Option) (*DeleteJobQueueOutput, error)
- func (c *Batch) DeregisterJobDefinition(input *DeregisterJobDefinitionInput) (*DeregisterJobDefinitionOutput, error)
- func (c *Batch) DeregisterJobDefinitionRequest(input *DeregisterJobDefinitionInput) (req *request.Request, output *DeregisterJobDefinitionOutput)
- func (c *Batch) DeregisterJobDefinitionWithContext(ctx aws.Context, input *DeregisterJobDefinitionInput, opts ...request.Option) (*DeregisterJobDefinitionOutput, error)
- func (c *Batch) DescribeComputeEnvironments(input *DescribeComputeEnvironmentsInput) (*DescribeComputeEnvironmentsOutput, error)
- func (c *Batch) DescribeComputeEnvironmentsRequest(input *DescribeComputeEnvironmentsInput) (req *request.Request, output *DescribeComputeEnvironmentsOutput)
- func (c *Batch) DescribeComputeEnvironmentsWithContext(ctx aws.Context, input *DescribeComputeEnvironmentsInput, ...) (*DescribeComputeEnvironmentsOutput, error)
- func (c *Batch) DescribeJobDefinitions(input *DescribeJobDefinitionsInput) (*DescribeJobDefinitionsOutput, error)
- func (c *Batch) DescribeJobDefinitionsRequest(input *DescribeJobDefinitionsInput) (req *request.Request, output *DescribeJobDefinitionsOutput)
- func (c *Batch) DescribeJobDefinitionsWithContext(ctx aws.Context, input *DescribeJobDefinitionsInput, opts ...request.Option) (*DescribeJobDefinitionsOutput, error)
- func (c *Batch) DescribeJobQueues(input *DescribeJobQueuesInput) (*DescribeJobQueuesOutput, error)
- func (c *Batch) DescribeJobQueuesRequest(input *DescribeJobQueuesInput) (req *request.Request, output *DescribeJobQueuesOutput)
- func (c *Batch) DescribeJobQueuesWithContext(ctx aws.Context, input *DescribeJobQueuesInput, opts ...request.Option) (*DescribeJobQueuesOutput, error)
- func (c *Batch) DescribeJobs(input *DescribeJobsInput) (*DescribeJobsOutput, error)
- func (c *Batch) DescribeJobsRequest(input *DescribeJobsInput) (req *request.Request, output *DescribeJobsOutput)
- func (c *Batch) DescribeJobsWithContext(ctx aws.Context, input *DescribeJobsInput, opts ...request.Option) (*DescribeJobsOutput, error)
- func (c *Batch) ListJobs(input *ListJobsInput) (*ListJobsOutput, error)
- func (c *Batch) ListJobsRequest(input *ListJobsInput) (req *request.Request, output *ListJobsOutput)
- func (c *Batch) ListJobsWithContext(ctx aws.Context, input *ListJobsInput, opts ...request.Option) (*ListJobsOutput, error)
- func (c *Batch) RegisterJobDefinition(input *RegisterJobDefinitionInput) (*RegisterJobDefinitionOutput, error)
- func (c *Batch) RegisterJobDefinitionRequest(input *RegisterJobDefinitionInput) (req *request.Request, output *RegisterJobDefinitionOutput)
- func (c *Batch) RegisterJobDefinitionWithContext(ctx aws.Context, input *RegisterJobDefinitionInput, opts ...request.Option) (*RegisterJobDefinitionOutput, error)
- func (c *Batch) SubmitJob(input *SubmitJobInput) (*SubmitJobOutput, error)
- func (c *Batch) SubmitJobRequest(input *SubmitJobInput) (req *request.Request, output *SubmitJobOutput)
- func (c *Batch) SubmitJobWithContext(ctx aws.Context, input *SubmitJobInput, opts ...request.Option) (*SubmitJobOutput, error)
- func (c *Batch) TerminateJob(input *TerminateJobInput) (*TerminateJobOutput, error)
- func (c *Batch) TerminateJobRequest(input *TerminateJobInput) (req *request.Request, output *TerminateJobOutput)
- func (c *Batch) TerminateJobWithContext(ctx aws.Context, input *TerminateJobInput, opts ...request.Option) (*TerminateJobOutput, error)
- func (c *Batch) UpdateComputeEnvironment(input *UpdateComputeEnvironmentInput) (*UpdateComputeEnvironmentOutput, error)
- func (c *Batch) UpdateComputeEnvironmentRequest(input *UpdateComputeEnvironmentInput) (req *request.Request, output *UpdateComputeEnvironmentOutput)
- func (c *Batch) UpdateComputeEnvironmentWithContext(ctx aws.Context, input *UpdateComputeEnvironmentInput, opts ...request.Option) (*UpdateComputeEnvironmentOutput, error)
- func (c *Batch) UpdateJobQueue(input *UpdateJobQueueInput) (*UpdateJobQueueOutput, error)
- func (c *Batch) UpdateJobQueueRequest(input *UpdateJobQueueInput) (req *request.Request, output *UpdateJobQueueOutput)
- func (c *Batch) UpdateJobQueueWithContext(ctx aws.Context, input *UpdateJobQueueInput, opts ...request.Option) (*UpdateJobQueueOutput, error)
- type CancelJobInput
- type CancelJobOutput
- type ComputeEnvironmentDetail
- func (s ComputeEnvironmentDetail) GoString() string
- func (s *ComputeEnvironmentDetail) SetComputeEnvironmentArn(v string) *ComputeEnvironmentDetail
- func (s *ComputeEnvironmentDetail) SetComputeEnvironmentName(v string) *ComputeEnvironmentDetail
- func (s *ComputeEnvironmentDetail) SetComputeResources(v *ComputeResource) *ComputeEnvironmentDetail
- func (s *ComputeEnvironmentDetail) SetEcsClusterArn(v string) *ComputeEnvironmentDetail
- func (s *ComputeEnvironmentDetail) SetServiceRole(v string) *ComputeEnvironmentDetail
- func (s *ComputeEnvironmentDetail) SetState(v string) *ComputeEnvironmentDetail
- func (s *ComputeEnvironmentDetail) SetStatus(v string) *ComputeEnvironmentDetail
- func (s *ComputeEnvironmentDetail) SetStatusReason(v string) *ComputeEnvironmentDetail
- func (s *ComputeEnvironmentDetail) SetType(v string) *ComputeEnvironmentDetail
- func (s ComputeEnvironmentDetail) String() string
- type ComputeEnvironmentOrder
- func (s ComputeEnvironmentOrder) GoString() string
- func (s *ComputeEnvironmentOrder) SetComputeEnvironment(v string) *ComputeEnvironmentOrder
- func (s *ComputeEnvironmentOrder) SetOrder(v int64) *ComputeEnvironmentOrder
- func (s ComputeEnvironmentOrder) String() string
- func (s *ComputeEnvironmentOrder) Validate() error
- type ComputeResource
- func (s ComputeResource) GoString() string
- func (s *ComputeResource) SetBidPercentage(v int64) *ComputeResource
- func (s *ComputeResource) SetDesiredvCpus(v int64) *ComputeResource
- func (s *ComputeResource) SetEc2KeyPair(v string) *ComputeResource
- func (s *ComputeResource) SetImageId(v string) *ComputeResource
- func (s *ComputeResource) SetInstanceRole(v string) *ComputeResource
- func (s *ComputeResource) SetInstanceTypes(v []*string) *ComputeResource
- func (s *ComputeResource) SetMaxvCpus(v int64) *ComputeResource
- func (s *ComputeResource) SetMinvCpus(v int64) *ComputeResource
- func (s *ComputeResource) SetSecurityGroupIds(v []*string) *ComputeResource
- func (s *ComputeResource) SetSpotIamFleetRole(v string) *ComputeResource
- func (s *ComputeResource) SetSubnets(v []*string) *ComputeResource
- func (s *ComputeResource) SetTags(v map[string]*string) *ComputeResource
- func (s *ComputeResource) SetType(v string) *ComputeResource
- func (s ComputeResource) String() string
- func (s *ComputeResource) Validate() error
- type ComputeResourceUpdate
- func (s ComputeResourceUpdate) GoString() string
- func (s *ComputeResourceUpdate) SetDesiredvCpus(v int64) *ComputeResourceUpdate
- func (s *ComputeResourceUpdate) SetMaxvCpus(v int64) *ComputeResourceUpdate
- func (s *ComputeResourceUpdate) SetMinvCpus(v int64) *ComputeResourceUpdate
- func (s ComputeResourceUpdate) String() string
- type ContainerDetail
- func (s ContainerDetail) GoString() string
- func (s *ContainerDetail) SetCommand(v []*string) *ContainerDetail
- func (s *ContainerDetail) SetContainerInstanceArn(v string) *ContainerDetail
- func (s *ContainerDetail) SetEnvironment(v []*KeyValuePair) *ContainerDetail
- func (s *ContainerDetail) SetExitCode(v int64) *ContainerDetail
- func (s *ContainerDetail) SetImage(v string) *ContainerDetail
- func (s *ContainerDetail) SetJobRoleArn(v string) *ContainerDetail
- func (s *ContainerDetail) SetLogStreamName(v string) *ContainerDetail
- func (s *ContainerDetail) SetMemory(v int64) *ContainerDetail
- func (s *ContainerDetail) SetMountPoints(v []*MountPoint) *ContainerDetail
- func (s *ContainerDetail) SetPrivileged(v bool) *ContainerDetail
- func (s *ContainerDetail) SetReadonlyRootFilesystem(v bool) *ContainerDetail
- func (s *ContainerDetail) SetReason(v string) *ContainerDetail
- func (s *ContainerDetail) SetTaskArn(v string) *ContainerDetail
- func (s *ContainerDetail) SetUlimits(v []*Ulimit) *ContainerDetail
- func (s *ContainerDetail) SetUser(v string) *ContainerDetail
- func (s *ContainerDetail) SetVcpus(v int64) *ContainerDetail
- func (s *ContainerDetail) SetVolumes(v []*Volume) *ContainerDetail
- func (s ContainerDetail) String() string
- type ContainerOverrides
- func (s ContainerOverrides) GoString() string
- func (s *ContainerOverrides) SetCommand(v []*string) *ContainerOverrides
- func (s *ContainerOverrides) SetEnvironment(v []*KeyValuePair) *ContainerOverrides
- func (s *ContainerOverrides) SetMemory(v int64) *ContainerOverrides
- func (s *ContainerOverrides) SetVcpus(v int64) *ContainerOverrides
- func (s ContainerOverrides) String() string
- type ContainerProperties
- func (s ContainerProperties) GoString() string
- func (s *ContainerProperties) SetCommand(v []*string) *ContainerProperties
- func (s *ContainerProperties) SetEnvironment(v []*KeyValuePair) *ContainerProperties
- func (s *ContainerProperties) SetImage(v string) *ContainerProperties
- func (s *ContainerProperties) SetJobRoleArn(v string) *ContainerProperties
- func (s *ContainerProperties) SetMemory(v int64) *ContainerProperties
- func (s *ContainerProperties) SetMountPoints(v []*MountPoint) *ContainerProperties
- func (s *ContainerProperties) SetPrivileged(v bool) *ContainerProperties
- func (s *ContainerProperties) SetReadonlyRootFilesystem(v bool) *ContainerProperties
- func (s *ContainerProperties) SetUlimits(v []*Ulimit) *ContainerProperties
- func (s *ContainerProperties) SetUser(v string) *ContainerProperties
- func (s *ContainerProperties) SetVcpus(v int64) *ContainerProperties
- func (s *ContainerProperties) SetVolumes(v []*Volume) *ContainerProperties
- func (s ContainerProperties) String() string
- func (s *ContainerProperties) Validate() error
- type ContainerSummary
- type CreateComputeEnvironmentInput
- func (s CreateComputeEnvironmentInput) GoString() string
- func (s *CreateComputeEnvironmentInput) SetComputeEnvironmentName(v string) *CreateComputeEnvironmentInput
- func (s *CreateComputeEnvironmentInput) SetComputeResources(v *ComputeResource) *CreateComputeEnvironmentInput
- func (s *CreateComputeEnvironmentInput) SetServiceRole(v string) *CreateComputeEnvironmentInput
- func (s *CreateComputeEnvironmentInput) SetState(v string) *CreateComputeEnvironmentInput
- func (s *CreateComputeEnvironmentInput) SetType(v string) *CreateComputeEnvironmentInput
- func (s CreateComputeEnvironmentInput) String() string
- func (s *CreateComputeEnvironmentInput) Validate() error
- type CreateComputeEnvironmentOutput
- func (s CreateComputeEnvironmentOutput) GoString() string
- func (s *CreateComputeEnvironmentOutput) SetComputeEnvironmentArn(v string) *CreateComputeEnvironmentOutput
- func (s *CreateComputeEnvironmentOutput) SetComputeEnvironmentName(v string) *CreateComputeEnvironmentOutput
- func (s CreateComputeEnvironmentOutput) String() string
- type CreateJobQueueInput
- func (s CreateJobQueueInput) GoString() string
- func (s *CreateJobQueueInput) SetComputeEnvironmentOrder(v []*ComputeEnvironmentOrder) *CreateJobQueueInput
- func (s *CreateJobQueueInput) SetJobQueueName(v string) *CreateJobQueueInput
- func (s *CreateJobQueueInput) SetPriority(v int64) *CreateJobQueueInput
- func (s *CreateJobQueueInput) SetState(v string) *CreateJobQueueInput
- func (s CreateJobQueueInput) String() string
- func (s *CreateJobQueueInput) Validate() error
- type CreateJobQueueOutput
- type DeleteComputeEnvironmentInput
- type DeleteComputeEnvironmentOutput
- type DeleteJobQueueInput
- type DeleteJobQueueOutput
- type DeregisterJobDefinitionInput
- type DeregisterJobDefinitionOutput
- type DescribeComputeEnvironmentsInput
- func (s DescribeComputeEnvironmentsInput) GoString() string
- func (s *DescribeComputeEnvironmentsInput) SetComputeEnvironments(v []*string) *DescribeComputeEnvironmentsInput
- func (s *DescribeComputeEnvironmentsInput) SetMaxResults(v int64) *DescribeComputeEnvironmentsInput
- func (s *DescribeComputeEnvironmentsInput) SetNextToken(v string) *DescribeComputeEnvironmentsInput
- func (s DescribeComputeEnvironmentsInput) String() string
- type DescribeComputeEnvironmentsOutput
- func (s DescribeComputeEnvironmentsOutput) GoString() string
- func (s *DescribeComputeEnvironmentsOutput) SetComputeEnvironments(v []*ComputeEnvironmentDetail) *DescribeComputeEnvironmentsOutput
- func (s *DescribeComputeEnvironmentsOutput) SetNextToken(v string) *DescribeComputeEnvironmentsOutput
- func (s DescribeComputeEnvironmentsOutput) String() string
- type DescribeJobDefinitionsInput
- func (s DescribeJobDefinitionsInput) GoString() string
- func (s *DescribeJobDefinitionsInput) SetJobDefinitionName(v string) *DescribeJobDefinitionsInput
- func (s *DescribeJobDefinitionsInput) SetJobDefinitions(v []*string) *DescribeJobDefinitionsInput
- func (s *DescribeJobDefinitionsInput) SetMaxResults(v int64) *DescribeJobDefinitionsInput
- func (s *DescribeJobDefinitionsInput) SetNextToken(v string) *DescribeJobDefinitionsInput
- func (s *DescribeJobDefinitionsInput) SetStatus(v string) *DescribeJobDefinitionsInput
- func (s DescribeJobDefinitionsInput) String() string
- type DescribeJobDefinitionsOutput
- func (s DescribeJobDefinitionsOutput) GoString() string
- func (s *DescribeJobDefinitionsOutput) SetJobDefinitions(v []*JobDefinition) *DescribeJobDefinitionsOutput
- func (s *DescribeJobDefinitionsOutput) SetNextToken(v string) *DescribeJobDefinitionsOutput
- func (s DescribeJobDefinitionsOutput) String() string
- type DescribeJobQueuesInput
- func (s DescribeJobQueuesInput) GoString() string
- func (s *DescribeJobQueuesInput) SetJobQueues(v []*string) *DescribeJobQueuesInput
- func (s *DescribeJobQueuesInput) SetMaxResults(v int64) *DescribeJobQueuesInput
- func (s *DescribeJobQueuesInput) SetNextToken(v string) *DescribeJobQueuesInput
- func (s DescribeJobQueuesInput) String() string
- type DescribeJobQueuesOutput
- type DescribeJobsInput
- type DescribeJobsOutput
- type Host
- type JobDefinition
- func (s JobDefinition) GoString() string
- func (s *JobDefinition) SetContainerProperties(v *ContainerProperties) *JobDefinition
- func (s *JobDefinition) SetJobDefinitionArn(v string) *JobDefinition
- func (s *JobDefinition) SetJobDefinitionName(v string) *JobDefinition
- func (s *JobDefinition) SetParameters(v map[string]*string) *JobDefinition
- func (s *JobDefinition) SetRetryStrategy(v *RetryStrategy) *JobDefinition
- func (s *JobDefinition) SetRevision(v int64) *JobDefinition
- func (s *JobDefinition) SetStatus(v string) *JobDefinition
- func (s *JobDefinition) SetTimeout(v *JobTimeout) *JobDefinition
- func (s *JobDefinition) SetType(v string) *JobDefinition
- func (s JobDefinition) String() string
- type JobDependency
- type JobDetail
- func (s JobDetail) GoString() string
- func (s *JobDetail) SetArrayProperties(v *ArrayPropertiesDetail) *JobDetail
- func (s *JobDetail) SetAttempts(v []*AttemptDetail) *JobDetail
- func (s *JobDetail) SetContainer(v *ContainerDetail) *JobDetail
- func (s *JobDetail) SetCreatedAt(v int64) *JobDetail
- func (s *JobDetail) SetDependsOn(v []*JobDependency) *JobDetail
- func (s *JobDetail) SetJobDefinition(v string) *JobDetail
- func (s *JobDetail) SetJobId(v string) *JobDetail
- func (s *JobDetail) SetJobName(v string) *JobDetail
- func (s *JobDetail) SetJobQueue(v string) *JobDetail
- func (s *JobDetail) SetParameters(v map[string]*string) *JobDetail
- func (s *JobDetail) SetRetryStrategy(v *RetryStrategy) *JobDetail
- func (s *JobDetail) SetStartedAt(v int64) *JobDetail
- func (s *JobDetail) SetStatus(v string) *JobDetail
- func (s *JobDetail) SetStatusReason(v string) *JobDetail
- func (s *JobDetail) SetStoppedAt(v int64) *JobDetail
- func (s *JobDetail) SetTimeout(v *JobTimeout) *JobDetail
- func (s JobDetail) String() string
- type JobQueueDetail
- func (s JobQueueDetail) GoString() string
- func (s *JobQueueDetail) SetComputeEnvironmentOrder(v []*ComputeEnvironmentOrder) *JobQueueDetail
- func (s *JobQueueDetail) SetJobQueueArn(v string) *JobQueueDetail
- func (s *JobQueueDetail) SetJobQueueName(v string) *JobQueueDetail
- func (s *JobQueueDetail) SetPriority(v int64) *JobQueueDetail
- func (s *JobQueueDetail) SetState(v string) *JobQueueDetail
- func (s *JobQueueDetail) SetStatus(v string) *JobQueueDetail
- func (s *JobQueueDetail) SetStatusReason(v string) *JobQueueDetail
- func (s JobQueueDetail) String() string
- type JobSummary
- func (s JobSummary) GoString() string
- func (s *JobSummary) SetArrayProperties(v *ArrayPropertiesSummary) *JobSummary
- func (s *JobSummary) SetContainer(v *ContainerSummary) *JobSummary
- func (s *JobSummary) SetCreatedAt(v int64) *JobSummary
- func (s *JobSummary) SetJobId(v string) *JobSummary
- func (s *JobSummary) SetJobName(v string) *JobSummary
- func (s *JobSummary) SetStartedAt(v int64) *JobSummary
- func (s *JobSummary) SetStatus(v string) *JobSummary
- func (s *JobSummary) SetStatusReason(v string) *JobSummary
- func (s *JobSummary) SetStoppedAt(v int64) *JobSummary
- func (s JobSummary) String() string
- type JobTimeout
- type KeyValuePair
- type ListJobsInput
- func (s ListJobsInput) GoString() string
- func (s *ListJobsInput) SetArrayJobId(v string) *ListJobsInput
- func (s *ListJobsInput) SetJobQueue(v string) *ListJobsInput
- func (s *ListJobsInput) SetJobStatus(v string) *ListJobsInput
- func (s *ListJobsInput) SetMaxResults(v int64) *ListJobsInput
- func (s *ListJobsInput) SetNextToken(v string) *ListJobsInput
- func (s ListJobsInput) String() string
- type ListJobsOutput
- type MountPoint
- type RegisterJobDefinitionInput
- func (s RegisterJobDefinitionInput) GoString() string
- func (s *RegisterJobDefinitionInput) SetContainerProperties(v *ContainerProperties) *RegisterJobDefinitionInput
- func (s *RegisterJobDefinitionInput) SetJobDefinitionName(v string) *RegisterJobDefinitionInput
- func (s *RegisterJobDefinitionInput) SetParameters(v map[string]*string) *RegisterJobDefinitionInput
- func (s *RegisterJobDefinitionInput) SetRetryStrategy(v *RetryStrategy) *RegisterJobDefinitionInput
- func (s *RegisterJobDefinitionInput) SetTimeout(v *JobTimeout) *RegisterJobDefinitionInput
- func (s *RegisterJobDefinitionInput) SetType(v string) *RegisterJobDefinitionInput
- func (s RegisterJobDefinitionInput) String() string
- func (s *RegisterJobDefinitionInput) Validate() error
- type RegisterJobDefinitionOutput
- func (s RegisterJobDefinitionOutput) GoString() string
- func (s *RegisterJobDefinitionOutput) SetJobDefinitionArn(v string) *RegisterJobDefinitionOutput
- func (s *RegisterJobDefinitionOutput) SetJobDefinitionName(v string) *RegisterJobDefinitionOutput
- func (s *RegisterJobDefinitionOutput) SetRevision(v int64) *RegisterJobDefinitionOutput
- func (s RegisterJobDefinitionOutput) String() string
- type RetryStrategy
- type SubmitJobInput
- func (s SubmitJobInput) GoString() string
- func (s *SubmitJobInput) SetArrayProperties(v *ArrayProperties) *SubmitJobInput
- func (s *SubmitJobInput) SetContainerOverrides(v *ContainerOverrides) *SubmitJobInput
- func (s *SubmitJobInput) SetDependsOn(v []*JobDependency) *SubmitJobInput
- func (s *SubmitJobInput) SetJobDefinition(v string) *SubmitJobInput
- func (s *SubmitJobInput) SetJobName(v string) *SubmitJobInput
- func (s *SubmitJobInput) SetJobQueue(v string) *SubmitJobInput
- func (s *SubmitJobInput) SetParameters(v map[string]*string) *SubmitJobInput
- func (s *SubmitJobInput) SetRetryStrategy(v *RetryStrategy) *SubmitJobInput
- func (s *SubmitJobInput) SetTimeout(v *JobTimeout) *SubmitJobInput
- func (s SubmitJobInput) String() string
- func (s *SubmitJobInput) Validate() error
- type SubmitJobOutput
- type TerminateJobInput
- type TerminateJobOutput
- type Ulimit
- type UpdateComputeEnvironmentInput
- func (s UpdateComputeEnvironmentInput) GoString() string
- func (s *UpdateComputeEnvironmentInput) SetComputeEnvironment(v string) *UpdateComputeEnvironmentInput
- func (s *UpdateComputeEnvironmentInput) SetComputeResources(v *ComputeResourceUpdate) *UpdateComputeEnvironmentInput
- func (s *UpdateComputeEnvironmentInput) SetServiceRole(v string) *UpdateComputeEnvironmentInput
- func (s *UpdateComputeEnvironmentInput) SetState(v string) *UpdateComputeEnvironmentInput
- func (s UpdateComputeEnvironmentInput) String() string
- func (s *UpdateComputeEnvironmentInput) Validate() error
- type UpdateComputeEnvironmentOutput
- func (s UpdateComputeEnvironmentOutput) GoString() string
- func (s *UpdateComputeEnvironmentOutput) SetComputeEnvironmentArn(v string) *UpdateComputeEnvironmentOutput
- func (s *UpdateComputeEnvironmentOutput) SetComputeEnvironmentName(v string) *UpdateComputeEnvironmentOutput
- func (s UpdateComputeEnvironmentOutput) String() string
- type UpdateJobQueueInput
- func (s UpdateJobQueueInput) GoString() string
- func (s *UpdateJobQueueInput) SetComputeEnvironmentOrder(v []*ComputeEnvironmentOrder) *UpdateJobQueueInput
- func (s *UpdateJobQueueInput) SetJobQueue(v string) *UpdateJobQueueInput
- func (s *UpdateJobQueueInput) SetPriority(v int64) *UpdateJobQueueInput
- func (s *UpdateJobQueueInput) SetState(v string) *UpdateJobQueueInput
- func (s UpdateJobQueueInput) String() string
- func (s *UpdateJobQueueInput) Validate() error
- type UpdateJobQueueOutput
- type Volume
Examples ¶
- Batch.CancelJob (Shared00)
- Batch.CreateComputeEnvironment (Shared00)
- Batch.CreateComputeEnvironment (Shared01)
- Batch.CreateJobQueue (Shared00)
- Batch.CreateJobQueue (Shared01)
- Batch.DeleteComputeEnvironment (Shared00)
- Batch.DeleteJobQueue (Shared00)
- Batch.DeregisterJobDefinition (Shared00)
- Batch.DescribeComputeEnvironments (Shared00)
- Batch.DescribeJobDefinitions (Shared00)
- Batch.DescribeJobQueues (Shared00)
- Batch.DescribeJobs (Shared00)
- Batch.ListJobs (Shared00)
- Batch.ListJobs (Shared01)
- Batch.RegisterJobDefinition (Shared00)
- Batch.SubmitJob (Shared00)
- Batch.TerminateJob (Shared00)
- Batch.UpdateComputeEnvironment (Shared00)
- Batch.UpdateJobQueue (Shared00)
Constants ¶
const ( // ArrayJobDependencyNToN is a ArrayJobDependency enum value ArrayJobDependencyNToN = "N_TO_N" // ArrayJobDependencySequential is a ArrayJobDependency enum value ArrayJobDependencySequential = "SEQUENTIAL" )
const ( // CEStateEnabled is a CEState enum value CEStateEnabled = "ENABLED" // CEStateDisabled is a CEState enum value CEStateDisabled = "DISABLED" )
const ( // CEStatusCreating is a CEStatus enum value CEStatusCreating = "CREATING" // CEStatusUpdating is a CEStatus enum value CEStatusUpdating = "UPDATING" // CEStatusDeleting is a CEStatus enum value CEStatusDeleting = "DELETING" // CEStatusDeleted is a CEStatus enum value CEStatusDeleted = "DELETED" // CEStatusValid is a CEStatus enum value CEStatusValid = "VALID" // CEStatusInvalid is a CEStatus enum value CEStatusInvalid = "INVALID" )
const ( // CETypeManaged is a CEType enum value CETypeManaged = "MANAGED" // CETypeUnmanaged is a CEType enum value CETypeUnmanaged = "UNMANAGED" )
const ( // CRTypeEc2 is a CRType enum value CRTypeEc2 = "EC2" // CRTypeSpot is a CRType enum value CRTypeSpot = "SPOT" )
const ( // JQStateEnabled is a JQState enum value JQStateEnabled = "ENABLED" // JQStateDisabled is a JQState enum value JQStateDisabled = "DISABLED" )
const ( // JQStatusCreating is a JQStatus enum value JQStatusCreating = "CREATING" // JQStatusUpdating is a JQStatus enum value JQStatusUpdating = "UPDATING" // JQStatusDeleting is a JQStatus enum value JQStatusDeleting = "DELETING" // JQStatusDeleted is a JQStatus enum value JQStatusDeleted = "DELETED" // JQStatusValid is a JQStatus enum value JQStatusValid = "VALID" // JQStatusInvalid is a JQStatus enum value JQStatusInvalid = "INVALID" )
const ( // JobStatusSubmitted is a JobStatus enum value JobStatusSubmitted = "SUBMITTED" // JobStatusPending is a JobStatus enum value JobStatusPending = "PENDING" // JobStatusRunnable is a JobStatus enum value JobStatusRunnable = "RUNNABLE" // JobStatusStarting is a JobStatus enum value JobStatusStarting = "STARTING" // JobStatusRunning is a JobStatus enum value JobStatusRunning = "RUNNING" // JobStatusSucceeded is a JobStatus enum value JobStatusSucceeded = "SUCCEEDED" // JobStatusFailed is a JobStatus enum value JobStatusFailed = "FAILED" )
const ( // ErrCodeClientException for service response error code // "ClientException". // // These errors are usually caused by a client action, such as using an action // or resource on behalf of a user that doesn't have permissions to use the // action or resource, or specifying an identifier that is not valid. ErrCodeClientException = "ClientException" // ErrCodeServerException for service response error code // "ServerException". // // These errors are usually caused by a server issue. ErrCodeServerException = "ServerException" )
const ( ServiceName = "batch" // Service endpoint prefix API calls made to. EndpointsID = ServiceName // Service ID for Regions and Endpoints metadata. ServiceID = "Batch" // ServiceID is a unique identifer of a specific service )
Service information constants
const (
// JobDefinitionTypeContainer is a JobDefinitionType enum value
JobDefinitionTypeContainer = "container"
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ArrayProperties ¶ added in v1.12.35
type ArrayProperties struct { // The size of the array job. Size *int64 `locationName:"size" type:"integer"` // contains filtered or unexported fields }
An object representing an AWS Batch array job.
func (ArrayProperties) GoString ¶ added in v1.12.35
func (s ArrayProperties) GoString() string
GoString returns the string representation
func (*ArrayProperties) SetSize ¶ added in v1.12.35
func (s *ArrayProperties) SetSize(v int64) *ArrayProperties
SetSize sets the Size field's value.
func (ArrayProperties) String ¶ added in v1.12.35
func (s ArrayProperties) String() string
String returns the string representation
type ArrayPropertiesDetail ¶ added in v1.12.35
type ArrayPropertiesDetail struct { // The job index within the array that is associated with this job. This parameter // is returned for array job children. Index *int64 `locationName:"index" type:"integer"` // The size of the array job. This parameter is returned for parent array jobs. Size *int64 `locationName:"size" type:"integer"` // A summary of the number of array job children in each available job status. // This parameter is returned for parent array jobs. StatusSummary map[string]*int64 `locationName:"statusSummary" type:"map"` // contains filtered or unexported fields }
An object representing the array properties of a job.
func (ArrayPropertiesDetail) GoString ¶ added in v1.12.35
func (s ArrayPropertiesDetail) GoString() string
GoString returns the string representation
func (*ArrayPropertiesDetail) SetIndex ¶ added in v1.12.35
func (s *ArrayPropertiesDetail) SetIndex(v int64) *ArrayPropertiesDetail
SetIndex sets the Index field's value.
func (*ArrayPropertiesDetail) SetSize ¶ added in v1.12.35
func (s *ArrayPropertiesDetail) SetSize(v int64) *ArrayPropertiesDetail
SetSize sets the Size field's value.
func (*ArrayPropertiesDetail) SetStatusSummary ¶ added in v1.12.35
func (s *ArrayPropertiesDetail) SetStatusSummary(v map[string]*int64) *ArrayPropertiesDetail
SetStatusSummary sets the StatusSummary field's value.
func (ArrayPropertiesDetail) String ¶ added in v1.12.35
func (s ArrayPropertiesDetail) String() string
String returns the string representation
type ArrayPropertiesSummary ¶ added in v1.12.35
type ArrayPropertiesSummary struct { // The job index within the array that is associated with this job. This parameter // is returned for children of array jobs. Index *int64 `locationName:"index" type:"integer"` // The size of the array job. This parameter is returned for parent array jobs. Size *int64 `locationName:"size" type:"integer"` // contains filtered or unexported fields }
An object representing the array properties of a job.
func (ArrayPropertiesSummary) GoString ¶ added in v1.12.35
func (s ArrayPropertiesSummary) GoString() string
GoString returns the string representation
func (*ArrayPropertiesSummary) SetIndex ¶ added in v1.12.35
func (s *ArrayPropertiesSummary) SetIndex(v int64) *ArrayPropertiesSummary
SetIndex sets the Index field's value.
func (*ArrayPropertiesSummary) SetSize ¶ added in v1.12.35
func (s *ArrayPropertiesSummary) SetSize(v int64) *ArrayPropertiesSummary
SetSize sets the Size field's value.
func (ArrayPropertiesSummary) String ¶ added in v1.12.35
func (s ArrayPropertiesSummary) String() string
String returns the string representation
type AttemptContainerDetail ¶ added in v1.8.5
type AttemptContainerDetail struct { // The Amazon Resource Name (ARN) of the Amazon ECS container instance that // hosts the job attempt. ContainerInstanceArn *string `locationName:"containerInstanceArn" type:"string"` // The exit code for the job attempt. A non-zero exit code is considered a failure. ExitCode *int64 `locationName:"exitCode" type:"integer"` // The name of the CloudWatch Logs log stream associated with the container. // The log group for AWS Batch jobs is /aws/batch/job. Each container attempt // receives a log stream name when they reach the RUNNING status. LogStreamName *string `locationName:"logStreamName" type:"string"` // A short (255 max characters) human-readable string to provide additional // details about a running or stopped container. Reason *string `locationName:"reason" type:"string"` // The Amazon Resource Name (ARN) of the Amazon ECS task that is associated // with the job attempt. Each container attempt receives a task ARN when they // reach the STARTING status. TaskArn *string `locationName:"taskArn" type:"string"` // contains filtered or unexported fields }
An object representing the details of a container that is part of a job attempt.
func (AttemptContainerDetail) GoString ¶ added in v1.8.5
func (s AttemptContainerDetail) GoString() string
GoString returns the string representation
func (*AttemptContainerDetail) SetContainerInstanceArn ¶ added in v1.8.5
func (s *AttemptContainerDetail) SetContainerInstanceArn(v string) *AttemptContainerDetail
SetContainerInstanceArn sets the ContainerInstanceArn field's value.
func (*AttemptContainerDetail) SetExitCode ¶ added in v1.8.5
func (s *AttemptContainerDetail) SetExitCode(v int64) *AttemptContainerDetail
SetExitCode sets the ExitCode field's value.
func (*AttemptContainerDetail) SetLogStreamName ¶ added in v1.10.25
func (s *AttemptContainerDetail) SetLogStreamName(v string) *AttemptContainerDetail
SetLogStreamName sets the LogStreamName field's value.
func (*AttemptContainerDetail) SetReason ¶ added in v1.8.5
func (s *AttemptContainerDetail) SetReason(v string) *AttemptContainerDetail
SetReason sets the Reason field's value.
func (*AttemptContainerDetail) SetTaskArn ¶ added in v1.8.5
func (s *AttemptContainerDetail) SetTaskArn(v string) *AttemptContainerDetail
SetTaskArn sets the TaskArn field's value.
func (AttemptContainerDetail) String ¶ added in v1.8.5
func (s AttemptContainerDetail) String() string
String returns the string representation
type AttemptDetail ¶ added in v1.8.5
type AttemptDetail struct { // Details about the container in this job attempt. Container *AttemptContainerDetail `locationName:"container" type:"structure"` // The Unix time stamp (in seconds and milliseconds) for when the attempt was // started (when the attempt transitioned from the STARTING state to the RUNNING // state). StartedAt *int64 `locationName:"startedAt" type:"long"` // A short, human-readable string to provide additional details about the current // status of the job attempt. StatusReason *string `locationName:"statusReason" type:"string"` // The Unix time stamp (in seconds and milliseconds) for when the attempt was // stopped (when the attempt transitioned from the RUNNING state to a terminal // state, such as SUCCEEDED or FAILED). StoppedAt *int64 `locationName:"stoppedAt" type:"long"` // contains filtered or unexported fields }
An object representing a job attempt.
func (AttemptDetail) GoString ¶ added in v1.8.5
func (s AttemptDetail) GoString() string
GoString returns the string representation
func (*AttemptDetail) SetContainer ¶ added in v1.8.5
func (s *AttemptDetail) SetContainer(v *AttemptContainerDetail) *AttemptDetail
SetContainer sets the Container field's value.
func (*AttemptDetail) SetStartedAt ¶ added in v1.8.5
func (s *AttemptDetail) SetStartedAt(v int64) *AttemptDetail
SetStartedAt sets the StartedAt field's value.
func (*AttemptDetail) SetStatusReason ¶ added in v1.8.5
func (s *AttemptDetail) SetStatusReason(v string) *AttemptDetail
SetStatusReason sets the StatusReason field's value.
func (*AttemptDetail) SetStoppedAt ¶ added in v1.8.5
func (s *AttemptDetail) SetStoppedAt(v int64) *AttemptDetail
SetStoppedAt sets the StoppedAt field's value.
func (AttemptDetail) String ¶ added in v1.8.5
func (s AttemptDetail) String() string
String returns the string representation
type Batch ¶
Batch provides the API operation methods for making requests to AWS Batch. See this package's package overview docs for details on the service.
Batch methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.
func New ¶
func New(p client.ConfigProvider, cfgs ...*aws.Config) *Batch
New creates a new instance of the Batch client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.
Example:
// Create a Batch client from just a session. svc := batch.New(mySession) // Create a Batch client with additional configuration svc := batch.New(mySession, aws.NewConfig().WithRegion("us-west-2"))
func (*Batch) CancelJob ¶
func (c *Batch) CancelJob(input *CancelJobInput) (*CancelJobOutput, error)
CancelJob API operation for AWS Batch.
Cancels a job in an AWS Batch job queue. Jobs that are in the SUBMITTED, PENDING, or RUNNABLE state are cancelled. Jobs that have progressed to STARTING or RUNNING are not cancelled (but the API operation still succeeds, even if no job is cancelled); these jobs must be terminated with the TerminateJob operation.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS Batch's API operation CancelJob for usage and error information.
Returned Error Codes:
ErrCodeClientException "ClientException" These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
ErrCodeServerException "ServerException" These errors are usually caused by a server issue.
See also, https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/CancelJob
func (*Batch) CancelJobRequest ¶
func (c *Batch) CancelJobRequest(input *CancelJobInput) (req *request.Request, output *CancelJobOutput)
CancelJobRequest generates a "aws/request.Request" representing the client's request for the CancelJob operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CancelJob for more information on using the CancelJob API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CancelJobRequest method. req, resp := client.CancelJobRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/CancelJob
func (*Batch) CancelJobWithContext ¶ added in v1.8.0
func (c *Batch) CancelJobWithContext(ctx aws.Context, input *CancelJobInput, opts ...request.Option) (*CancelJobOutput, error)
CancelJobWithContext is the same as CancelJob with the addition of the ability to pass a context and additional request options.
See CancelJob for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Batch) CreateComputeEnvironment ¶
func (c *Batch) CreateComputeEnvironment(input *CreateComputeEnvironmentInput) (*CreateComputeEnvironmentOutput, error)
CreateComputeEnvironment API operation for AWS Batch.
Creates an AWS Batch compute environment. You can create MANAGED or UNMANAGED compute environments.
In a managed compute environment, AWS Batch manages the compute resources within the environment, based on the compute resources that you specify. Instances launched into a managed compute environment use a recent, approved version of the Amazon ECS-optimized AMI. You can choose to use Amazon EC2 On-Demand Instances in your managed compute environment, or you can use Amazon EC2 Spot Instances that only launch when the Spot bid price is below a specified percentage of the On-Demand price.
In an unmanaged compute environment, you can manage your own compute resources. This provides more compute resource configuration options, such as using a custom AMI, but you must ensure that your AMI meets the Amazon ECS container instance AMI specification. For more information, see Container Instance AMIs (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/container_instance_AMIs.html) in the Amazon Elastic Container Service Developer Guide. After you have created your unmanaged compute environment, you can use the DescribeComputeEnvironments operation to find the Amazon ECS cluster that is associated with it and then manually launch your container instances into that Amazon ECS cluster. For more information, see Launching an Amazon ECS Container Instance (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_container_instance.html) in the Amazon Elastic Container Service Developer Guide.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS Batch's API operation CreateComputeEnvironment for usage and error information.
Returned Error Codes:
ErrCodeClientException "ClientException" These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
ErrCodeServerException "ServerException" These errors are usually caused by a server issue.
See also, https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/CreateComputeEnvironment
func (*Batch) CreateComputeEnvironmentRequest ¶
func (c *Batch) CreateComputeEnvironmentRequest(input *CreateComputeEnvironmentInput) (req *request.Request, output *CreateComputeEnvironmentOutput)
CreateComputeEnvironmentRequest generates a "aws/request.Request" representing the client's request for the CreateComputeEnvironment operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateComputeEnvironment for more information on using the CreateComputeEnvironment API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CreateComputeEnvironmentRequest method. req, resp := client.CreateComputeEnvironmentRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/CreateComputeEnvironment
func (*Batch) CreateComputeEnvironmentWithContext ¶ added in v1.8.0
func (c *Batch) CreateComputeEnvironmentWithContext(ctx aws.Context, input *CreateComputeEnvironmentInput, opts ...request.Option) (*CreateComputeEnvironmentOutput, error)
CreateComputeEnvironmentWithContext is the same as CreateComputeEnvironment with the addition of the ability to pass a context and additional request options.
See CreateComputeEnvironment for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Batch) CreateJobQueue ¶
func (c *Batch) CreateJobQueue(input *CreateJobQueueInput) (*CreateJobQueueOutput, error)
CreateJobQueue API operation for AWS Batch.
Creates an AWS Batch job queue. When you create a job queue, you associate one or more compute environments to the queue and assign an order of preference for the compute environments.
You also set a priority to the job queue that determines the order in which the AWS Batch scheduler places jobs onto its associated compute environments. For example, if a compute environment is associated with more than one job queue, the job queue with a higher priority is given preference for scheduling jobs to that compute environment.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS Batch's API operation CreateJobQueue for usage and error information.
Returned Error Codes:
ErrCodeClientException "ClientException" These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
ErrCodeServerException "ServerException" These errors are usually caused by a server issue.
See also, https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/CreateJobQueue
func (*Batch) CreateJobQueueRequest ¶
func (c *Batch) CreateJobQueueRequest(input *CreateJobQueueInput) (req *request.Request, output *CreateJobQueueOutput)
CreateJobQueueRequest generates a "aws/request.Request" representing the client's request for the CreateJobQueue operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateJobQueue for more information on using the CreateJobQueue API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CreateJobQueueRequest method. req, resp := client.CreateJobQueueRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/CreateJobQueue
func (*Batch) CreateJobQueueWithContext ¶ added in v1.8.0
func (c *Batch) CreateJobQueueWithContext(ctx aws.Context, input *CreateJobQueueInput, opts ...request.Option) (*CreateJobQueueOutput, error)
CreateJobQueueWithContext is the same as CreateJobQueue with the addition of the ability to pass a context and additional request options.
See CreateJobQueue for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Batch) DeleteComputeEnvironment ¶
func (c *Batch) DeleteComputeEnvironment(input *DeleteComputeEnvironmentInput) (*DeleteComputeEnvironmentOutput, error)
DeleteComputeEnvironment API operation for AWS Batch.
Deletes an AWS Batch compute environment.
Before you can delete a compute environment, you must set its state to DISABLED with the UpdateComputeEnvironment API operation and disassociate it from any job queues with the UpdateJobQueue API operation.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS Batch's API operation DeleteComputeEnvironment for usage and error information.
Returned Error Codes:
ErrCodeClientException "ClientException" These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
ErrCodeServerException "ServerException" These errors are usually caused by a server issue.
See also, https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DeleteComputeEnvironment
func (*Batch) DeleteComputeEnvironmentRequest ¶
func (c *Batch) DeleteComputeEnvironmentRequest(input *DeleteComputeEnvironmentInput) (req *request.Request, output *DeleteComputeEnvironmentOutput)
DeleteComputeEnvironmentRequest generates a "aws/request.Request" representing the client's request for the DeleteComputeEnvironment operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteComputeEnvironment for more information on using the DeleteComputeEnvironment API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeleteComputeEnvironmentRequest method. req, resp := client.DeleteComputeEnvironmentRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DeleteComputeEnvironment
func (*Batch) DeleteComputeEnvironmentWithContext ¶ added in v1.8.0
func (c *Batch) DeleteComputeEnvironmentWithContext(ctx aws.Context, input *DeleteComputeEnvironmentInput, opts ...request.Option) (*DeleteComputeEnvironmentOutput, error)
DeleteComputeEnvironmentWithContext is the same as DeleteComputeEnvironment with the addition of the ability to pass a context and additional request options.
See DeleteComputeEnvironment for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Batch) DeleteJobQueue ¶
func (c *Batch) DeleteJobQueue(input *DeleteJobQueueInput) (*DeleteJobQueueOutput, error)
DeleteJobQueue API operation for AWS Batch.
Deletes the specified job queue. You must first disable submissions for a queue with the UpdateJobQueue operation. All jobs in the queue are terminated when you delete a job queue.
It is not necessary to disassociate compute environments from a queue before submitting a DeleteJobQueue request.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS Batch's API operation DeleteJobQueue for usage and error information.
Returned Error Codes:
ErrCodeClientException "ClientException" These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
ErrCodeServerException "ServerException" These errors are usually caused by a server issue.
See also, https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DeleteJobQueue
func (*Batch) DeleteJobQueueRequest ¶
func (c *Batch) DeleteJobQueueRequest(input *DeleteJobQueueInput) (req *request.Request, output *DeleteJobQueueOutput)
DeleteJobQueueRequest generates a "aws/request.Request" representing the client's request for the DeleteJobQueue operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteJobQueue for more information on using the DeleteJobQueue API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeleteJobQueueRequest method. req, resp := client.DeleteJobQueueRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DeleteJobQueue
func (*Batch) DeleteJobQueueWithContext ¶ added in v1.8.0
func (c *Batch) DeleteJobQueueWithContext(ctx aws.Context, input *DeleteJobQueueInput, opts ...request.Option) (*DeleteJobQueueOutput, error)
DeleteJobQueueWithContext is the same as DeleteJobQueue with the addition of the ability to pass a context and additional request options.
See DeleteJobQueue for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Batch) DeregisterJobDefinition ¶
func (c *Batch) DeregisterJobDefinition(input *DeregisterJobDefinitionInput) (*DeregisterJobDefinitionOutput, error)
DeregisterJobDefinition API operation for AWS Batch.
Deregisters an AWS Batch job definition.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS Batch's API operation DeregisterJobDefinition for usage and error information.
Returned Error Codes:
ErrCodeClientException "ClientException" These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
ErrCodeServerException "ServerException" These errors are usually caused by a server issue.
See also, https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DeregisterJobDefinition
func (*Batch) DeregisterJobDefinitionRequest ¶
func (c *Batch) DeregisterJobDefinitionRequest(input *DeregisterJobDefinitionInput) (req *request.Request, output *DeregisterJobDefinitionOutput)
DeregisterJobDefinitionRequest generates a "aws/request.Request" representing the client's request for the DeregisterJobDefinition operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeregisterJobDefinition for more information on using the DeregisterJobDefinition API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeregisterJobDefinitionRequest method. req, resp := client.DeregisterJobDefinitionRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DeregisterJobDefinition
func (*Batch) DeregisterJobDefinitionWithContext ¶ added in v1.8.0
func (c *Batch) DeregisterJobDefinitionWithContext(ctx aws.Context, input *DeregisterJobDefinitionInput, opts ...request.Option) (*DeregisterJobDefinitionOutput, error)
DeregisterJobDefinitionWithContext is the same as DeregisterJobDefinition with the addition of the ability to pass a context and additional request options.
See DeregisterJobDefinition for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Batch) DescribeComputeEnvironments ¶
func (c *Batch) DescribeComputeEnvironments(input *DescribeComputeEnvironmentsInput) (*DescribeComputeEnvironmentsOutput, error)
DescribeComputeEnvironments API operation for AWS Batch.
Describes one or more of your compute environments.
If you are using an unmanaged compute environment, you can use the DescribeComputeEnvironment operation to determine the ecsClusterArn that you should launch your Amazon ECS container instances into.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS Batch's API operation DescribeComputeEnvironments for usage and error information.
Returned Error Codes:
ErrCodeClientException "ClientException" These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
ErrCodeServerException "ServerException" These errors are usually caused by a server issue.
See also, https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeComputeEnvironments
func (*Batch) DescribeComputeEnvironmentsRequest ¶
func (c *Batch) DescribeComputeEnvironmentsRequest(input *DescribeComputeEnvironmentsInput) (req *request.Request, output *DescribeComputeEnvironmentsOutput)
DescribeComputeEnvironmentsRequest generates a "aws/request.Request" representing the client's request for the DescribeComputeEnvironments operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeComputeEnvironments for more information on using the DescribeComputeEnvironments API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeComputeEnvironmentsRequest method. req, resp := client.DescribeComputeEnvironmentsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeComputeEnvironments
func (*Batch) DescribeComputeEnvironmentsWithContext ¶ added in v1.8.0
func (c *Batch) DescribeComputeEnvironmentsWithContext(ctx aws.Context, input *DescribeComputeEnvironmentsInput, opts ...request.Option) (*DescribeComputeEnvironmentsOutput, error)
DescribeComputeEnvironmentsWithContext is the same as DescribeComputeEnvironments with the addition of the ability to pass a context and additional request options.
See DescribeComputeEnvironments for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Batch) DescribeJobDefinitions ¶
func (c *Batch) DescribeJobDefinitions(input *DescribeJobDefinitionsInput) (*DescribeJobDefinitionsOutput, error)
DescribeJobDefinitions API operation for AWS Batch.
Describes a list of job definitions. You can specify a status (such as ACTIVE) to only return job definitions that match that status.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS Batch's API operation DescribeJobDefinitions for usage and error information.
Returned Error Codes:
ErrCodeClientException "ClientException" These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
ErrCodeServerException "ServerException" These errors are usually caused by a server issue.
See also, https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeJobDefinitions
func (*Batch) DescribeJobDefinitionsRequest ¶
func (c *Batch) DescribeJobDefinitionsRequest(input *DescribeJobDefinitionsInput) (req *request.Request, output *DescribeJobDefinitionsOutput)
DescribeJobDefinitionsRequest generates a "aws/request.Request" representing the client's request for the DescribeJobDefinitions operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeJobDefinitions for more information on using the DescribeJobDefinitions API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeJobDefinitionsRequest method. req, resp := client.DescribeJobDefinitionsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeJobDefinitions
func (*Batch) DescribeJobDefinitionsWithContext ¶ added in v1.8.0
func (c *Batch) DescribeJobDefinitionsWithContext(ctx aws.Context, input *DescribeJobDefinitionsInput, opts ...request.Option) (*DescribeJobDefinitionsOutput, error)
DescribeJobDefinitionsWithContext is the same as DescribeJobDefinitions with the addition of the ability to pass a context and additional request options.
See DescribeJobDefinitions for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Batch) DescribeJobQueues ¶
func (c *Batch) DescribeJobQueues(input *DescribeJobQueuesInput) (*DescribeJobQueuesOutput, error)
DescribeJobQueues API operation for AWS Batch.
Describes one or more of your job queues.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS Batch's API operation DescribeJobQueues for usage and error information.
Returned Error Codes:
ErrCodeClientException "ClientException" These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
ErrCodeServerException "ServerException" These errors are usually caused by a server issue.
See also, https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeJobQueues
func (*Batch) DescribeJobQueuesRequest ¶
func (c *Batch) DescribeJobQueuesRequest(input *DescribeJobQueuesInput) (req *request.Request, output *DescribeJobQueuesOutput)
DescribeJobQueuesRequest generates a "aws/request.Request" representing the client's request for the DescribeJobQueues operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeJobQueues for more information on using the DescribeJobQueues API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeJobQueuesRequest method. req, resp := client.DescribeJobQueuesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeJobQueues
func (*Batch) DescribeJobQueuesWithContext ¶ added in v1.8.0
func (c *Batch) DescribeJobQueuesWithContext(ctx aws.Context, input *DescribeJobQueuesInput, opts ...request.Option) (*DescribeJobQueuesOutput, error)
DescribeJobQueuesWithContext is the same as DescribeJobQueues with the addition of the ability to pass a context and additional request options.
See DescribeJobQueues for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Batch) DescribeJobs ¶
func (c *Batch) DescribeJobs(input *DescribeJobsInput) (*DescribeJobsOutput, error)
DescribeJobs API operation for AWS Batch.
Describes a list of AWS Batch jobs.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS Batch's API operation DescribeJobs for usage and error information.
Returned Error Codes:
ErrCodeClientException "ClientException" These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
ErrCodeServerException "ServerException" These errors are usually caused by a server issue.
See also, https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeJobs
func (*Batch) DescribeJobsRequest ¶
func (c *Batch) DescribeJobsRequest(input *DescribeJobsInput) (req *request.Request, output *DescribeJobsOutput)
DescribeJobsRequest generates a "aws/request.Request" representing the client's request for the DescribeJobs operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeJobs for more information on using the DescribeJobs API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeJobsRequest method. req, resp := client.DescribeJobsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeJobs
func (*Batch) DescribeJobsWithContext ¶ added in v1.8.0
func (c *Batch) DescribeJobsWithContext(ctx aws.Context, input *DescribeJobsInput, opts ...request.Option) (*DescribeJobsOutput, error)
DescribeJobsWithContext is the same as DescribeJobs with the addition of the ability to pass a context and additional request options.
See DescribeJobs for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Batch) ListJobs ¶
func (c *Batch) ListJobs(input *ListJobsInput) (*ListJobsOutput, error)
ListJobs API operation for AWS Batch.
Returns a list of task jobs for a specified job queue. You can filter the results by job status with the jobStatus parameter. If you do not specify a status, only RUNNING jobs are returned.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS Batch's API operation ListJobs for usage and error information.
Returned Error Codes:
ErrCodeClientException "ClientException" These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
ErrCodeServerException "ServerException" These errors are usually caused by a server issue.
See also, https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ListJobs
func (*Batch) ListJobsRequest ¶
func (c *Batch) ListJobsRequest(input *ListJobsInput) (req *request.Request, output *ListJobsOutput)
ListJobsRequest generates a "aws/request.Request" representing the client's request for the ListJobs operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListJobs for more information on using the ListJobs API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListJobsRequest method. req, resp := client.ListJobsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ListJobs
func (*Batch) ListJobsWithContext ¶ added in v1.8.0
func (c *Batch) ListJobsWithContext(ctx aws.Context, input *ListJobsInput, opts ...request.Option) (*ListJobsOutput, error)
ListJobsWithContext is the same as ListJobs with the addition of the ability to pass a context and additional request options.
See ListJobs for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Batch) RegisterJobDefinition ¶
func (c *Batch) RegisterJobDefinition(input *RegisterJobDefinitionInput) (*RegisterJobDefinitionOutput, error)
RegisterJobDefinition API operation for AWS Batch.
Registers an AWS Batch job definition.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS Batch's API operation RegisterJobDefinition for usage and error information.
Returned Error Codes:
ErrCodeClientException "ClientException" These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
ErrCodeServerException "ServerException" These errors are usually caused by a server issue.
See also, https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/RegisterJobDefinition
func (*Batch) RegisterJobDefinitionRequest ¶
func (c *Batch) RegisterJobDefinitionRequest(input *RegisterJobDefinitionInput) (req *request.Request, output *RegisterJobDefinitionOutput)
RegisterJobDefinitionRequest generates a "aws/request.Request" representing the client's request for the RegisterJobDefinition operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See RegisterJobDefinition for more information on using the RegisterJobDefinition API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the RegisterJobDefinitionRequest method. req, resp := client.RegisterJobDefinitionRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/RegisterJobDefinition
func (*Batch) RegisterJobDefinitionWithContext ¶ added in v1.8.0
func (c *Batch) RegisterJobDefinitionWithContext(ctx aws.Context, input *RegisterJobDefinitionInput, opts ...request.Option) (*RegisterJobDefinitionOutput, error)
RegisterJobDefinitionWithContext is the same as RegisterJobDefinition with the addition of the ability to pass a context and additional request options.
See RegisterJobDefinition for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Batch) SubmitJob ¶
func (c *Batch) SubmitJob(input *SubmitJobInput) (*SubmitJobOutput, error)
SubmitJob API operation for AWS Batch.
Submits an AWS Batch job from a job definition. Parameters specified during SubmitJob override parameters defined in the job definition.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS Batch's API operation SubmitJob for usage and error information.
Returned Error Codes:
ErrCodeClientException "ClientException" These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
ErrCodeServerException "ServerException" These errors are usually caused by a server issue.
See also, https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/SubmitJob
func (*Batch) SubmitJobRequest ¶
func (c *Batch) SubmitJobRequest(input *SubmitJobInput) (req *request.Request, output *SubmitJobOutput)
SubmitJobRequest generates a "aws/request.Request" representing the client's request for the SubmitJob operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See SubmitJob for more information on using the SubmitJob API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the SubmitJobRequest method. req, resp := client.SubmitJobRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/SubmitJob
func (*Batch) SubmitJobWithContext ¶ added in v1.8.0
func (c *Batch) SubmitJobWithContext(ctx aws.Context, input *SubmitJobInput, opts ...request.Option) (*SubmitJobOutput, error)
SubmitJobWithContext is the same as SubmitJob with the addition of the ability to pass a context and additional request options.
See SubmitJob for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Batch) TerminateJob ¶
func (c *Batch) TerminateJob(input *TerminateJobInput) (*TerminateJobOutput, error)
TerminateJob API operation for AWS Batch.
Terminates a job in a job queue. Jobs that are in the STARTING or RUNNING state are terminated, which causes them to transition to FAILED. Jobs that have not progressed to the STARTING state are cancelled.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS Batch's API operation TerminateJob for usage and error information.
Returned Error Codes:
ErrCodeClientException "ClientException" These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
ErrCodeServerException "ServerException" These errors are usually caused by a server issue.
See also, https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/TerminateJob
func (*Batch) TerminateJobRequest ¶
func (c *Batch) TerminateJobRequest(input *TerminateJobInput) (req *request.Request, output *TerminateJobOutput)
TerminateJobRequest generates a "aws/request.Request" representing the client's request for the TerminateJob operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See TerminateJob for more information on using the TerminateJob API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the TerminateJobRequest method. req, resp := client.TerminateJobRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/TerminateJob
func (*Batch) TerminateJobWithContext ¶ added in v1.8.0
func (c *Batch) TerminateJobWithContext(ctx aws.Context, input *TerminateJobInput, opts ...request.Option) (*TerminateJobOutput, error)
TerminateJobWithContext is the same as TerminateJob with the addition of the ability to pass a context and additional request options.
See TerminateJob for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Batch) UpdateComputeEnvironment ¶
func (c *Batch) UpdateComputeEnvironment(input *UpdateComputeEnvironmentInput) (*UpdateComputeEnvironmentOutput, error)
UpdateComputeEnvironment API operation for AWS Batch.
Updates an AWS Batch compute environment.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS Batch's API operation UpdateComputeEnvironment for usage and error information.
Returned Error Codes:
ErrCodeClientException "ClientException" These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
ErrCodeServerException "ServerException" These errors are usually caused by a server issue.
See also, https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/UpdateComputeEnvironment
func (*Batch) UpdateComputeEnvironmentRequest ¶
func (c *Batch) UpdateComputeEnvironmentRequest(input *UpdateComputeEnvironmentInput) (req *request.Request, output *UpdateComputeEnvironmentOutput)
UpdateComputeEnvironmentRequest generates a "aws/request.Request" representing the client's request for the UpdateComputeEnvironment operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UpdateComputeEnvironment for more information on using the UpdateComputeEnvironment API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the UpdateComputeEnvironmentRequest method. req, resp := client.UpdateComputeEnvironmentRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/UpdateComputeEnvironment
func (*Batch) UpdateComputeEnvironmentWithContext ¶ added in v1.8.0
func (c *Batch) UpdateComputeEnvironmentWithContext(ctx aws.Context, input *UpdateComputeEnvironmentInput, opts ...request.Option) (*UpdateComputeEnvironmentOutput, error)
UpdateComputeEnvironmentWithContext is the same as UpdateComputeEnvironment with the addition of the ability to pass a context and additional request options.
See UpdateComputeEnvironment for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Batch) UpdateJobQueue ¶
func (c *Batch) UpdateJobQueue(input *UpdateJobQueueInput) (*UpdateJobQueueOutput, error)
UpdateJobQueue API operation for AWS Batch.
Updates a job queue.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS Batch's API operation UpdateJobQueue for usage and error information.
Returned Error Codes:
ErrCodeClientException "ClientException" These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
ErrCodeServerException "ServerException" These errors are usually caused by a server issue.
See also, https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/UpdateJobQueue
func (*Batch) UpdateJobQueueRequest ¶
func (c *Batch) UpdateJobQueueRequest(input *UpdateJobQueueInput) (req *request.Request, output *UpdateJobQueueOutput)
UpdateJobQueueRequest generates a "aws/request.Request" representing the client's request for the UpdateJobQueue operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UpdateJobQueue for more information on using the UpdateJobQueue API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the UpdateJobQueueRequest method. req, resp := client.UpdateJobQueueRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/UpdateJobQueue
func (*Batch) UpdateJobQueueWithContext ¶ added in v1.8.0
func (c *Batch) UpdateJobQueueWithContext(ctx aws.Context, input *UpdateJobQueueInput, opts ...request.Option) (*UpdateJobQueueOutput, error)
UpdateJobQueueWithContext is the same as UpdateJobQueue with the addition of the ability to pass a context and additional request options.
See UpdateJobQueue for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
type CancelJobInput ¶
type CancelJobInput struct { // The AWS Batch job ID of the job to cancel. // // JobId is a required field JobId *string `locationName:"jobId" type:"string" required:"true"` // A message to attach to the job that explains the reason for canceling it. // This message is returned by future DescribeJobs operations on the job. This // message is also recorded in the AWS Batch activity logs. // // Reason is a required field Reason *string `locationName:"reason" type:"string" required:"true"` // contains filtered or unexported fields }
func (CancelJobInput) GoString ¶
func (s CancelJobInput) GoString() string
GoString returns the string representation
func (*CancelJobInput) SetJobId ¶
func (s *CancelJobInput) SetJobId(v string) *CancelJobInput
SetJobId sets the JobId field's value.
func (*CancelJobInput) SetReason ¶
func (s *CancelJobInput) SetReason(v string) *CancelJobInput
SetReason sets the Reason field's value.
func (CancelJobInput) String ¶
func (s CancelJobInput) String() string
String returns the string representation
func (*CancelJobInput) Validate ¶
func (s *CancelJobInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CancelJobOutput ¶
type CancelJobOutput struct {
// contains filtered or unexported fields
}
func (CancelJobOutput) GoString ¶
func (s CancelJobOutput) GoString() string
GoString returns the string representation
func (CancelJobOutput) String ¶
func (s CancelJobOutput) String() string
String returns the string representation
type ComputeEnvironmentDetail ¶
type ComputeEnvironmentDetail struct { // The Amazon Resource Name (ARN) of the compute environment. // // ComputeEnvironmentArn is a required field ComputeEnvironmentArn *string `locationName:"computeEnvironmentArn" type:"string" required:"true"` // The name of the compute environment. // // ComputeEnvironmentName is a required field ComputeEnvironmentName *string `locationName:"computeEnvironmentName" type:"string" required:"true"` // The compute resources defined for the compute environment. ComputeResources *ComputeResource `locationName:"computeResources" type:"structure"` // The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster used // by the compute environment. // // EcsClusterArn is a required field EcsClusterArn *string `locationName:"ecsClusterArn" type:"string" required:"true"` // The service role associated with the compute environment that allows AWS // Batch to make calls to AWS API operations on your behalf. ServiceRole *string `locationName:"serviceRole" type:"string"` // The state of the compute environment. The valid values are ENABLED or DISABLED. // An ENABLED state indicates that you can register instances with the compute // environment and that the associated instances can accept jobs. State *string `locationName:"state" type:"string" enum:"CEState"` // The current status of the compute environment (for example, CREATING or VALID). Status *string `locationName:"status" type:"string" enum:"CEStatus"` // A short, human-readable string to provide additional details about the current // status of the compute environment. StatusReason *string `locationName:"statusReason" type:"string"` // The type of the compute environment. Type *string `locationName:"type" type:"string" enum:"CEType"` // contains filtered or unexported fields }
An object representing an AWS Batch compute environment.
func (ComputeEnvironmentDetail) GoString ¶
func (s ComputeEnvironmentDetail) GoString() string
GoString returns the string representation
func (*ComputeEnvironmentDetail) SetComputeEnvironmentArn ¶
func (s *ComputeEnvironmentDetail) SetComputeEnvironmentArn(v string) *ComputeEnvironmentDetail
SetComputeEnvironmentArn sets the ComputeEnvironmentArn field's value.
func (*ComputeEnvironmentDetail) SetComputeEnvironmentName ¶
func (s *ComputeEnvironmentDetail) SetComputeEnvironmentName(v string) *ComputeEnvironmentDetail
SetComputeEnvironmentName sets the ComputeEnvironmentName field's value.
func (*ComputeEnvironmentDetail) SetComputeResources ¶
func (s *ComputeEnvironmentDetail) SetComputeResources(v *ComputeResource) *ComputeEnvironmentDetail
SetComputeResources sets the ComputeResources field's value.
func (*ComputeEnvironmentDetail) SetEcsClusterArn ¶
func (s *ComputeEnvironmentDetail) SetEcsClusterArn(v string) *ComputeEnvironmentDetail
SetEcsClusterArn sets the EcsClusterArn field's value.
func (*ComputeEnvironmentDetail) SetServiceRole ¶
func (s *ComputeEnvironmentDetail) SetServiceRole(v string) *ComputeEnvironmentDetail
SetServiceRole sets the ServiceRole field's value.
func (*ComputeEnvironmentDetail) SetState ¶
func (s *ComputeEnvironmentDetail) SetState(v string) *ComputeEnvironmentDetail
SetState sets the State field's value.
func (*ComputeEnvironmentDetail) SetStatus ¶
func (s *ComputeEnvironmentDetail) SetStatus(v string) *ComputeEnvironmentDetail
SetStatus sets the Status field's value.
func (*ComputeEnvironmentDetail) SetStatusReason ¶
func (s *ComputeEnvironmentDetail) SetStatusReason(v string) *ComputeEnvironmentDetail
SetStatusReason sets the StatusReason field's value.
func (*ComputeEnvironmentDetail) SetType ¶
func (s *ComputeEnvironmentDetail) SetType(v string) *ComputeEnvironmentDetail
SetType sets the Type field's value.
func (ComputeEnvironmentDetail) String ¶
func (s ComputeEnvironmentDetail) String() string
String returns the string representation
type ComputeEnvironmentOrder ¶
type ComputeEnvironmentOrder struct { // The Amazon Resource Name (ARN) of the compute environment. // // ComputeEnvironment is a required field ComputeEnvironment *string `locationName:"computeEnvironment" type:"string" required:"true"` // The order of the compute environment. // // Order is a required field Order *int64 `locationName:"order" type:"integer" required:"true"` // contains filtered or unexported fields }
The order in which compute environments are tried for job placement within a queue. Compute environments are tried in ascending order. For example, if two compute environments are associated with a job queue, the compute environment with a lower order integer value is tried for job placement first.
func (ComputeEnvironmentOrder) GoString ¶
func (s ComputeEnvironmentOrder) GoString() string
GoString returns the string representation
func (*ComputeEnvironmentOrder) SetComputeEnvironment ¶
func (s *ComputeEnvironmentOrder) SetComputeEnvironment(v string) *ComputeEnvironmentOrder
SetComputeEnvironment sets the ComputeEnvironment field's value.
func (*ComputeEnvironmentOrder) SetOrder ¶
func (s *ComputeEnvironmentOrder) SetOrder(v int64) *ComputeEnvironmentOrder
SetOrder sets the Order field's value.
func (ComputeEnvironmentOrder) String ¶
func (s ComputeEnvironmentOrder) String() string
String returns the string representation
func (*ComputeEnvironmentOrder) Validate ¶
func (s *ComputeEnvironmentOrder) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ComputeResource ¶
type ComputeResource struct { // The minimum percentage that a Spot Instance price must be when compared with // the On-Demand price for that instance type before instances are launched. // For example, if your bid percentage is 20%, then the Spot price must be below // 20% of the current On-Demand price for that EC2 instance. BidPercentage *int64 `locationName:"bidPercentage" type:"integer"` // The desired number of EC2 vCPUS in the compute environment. DesiredvCpus *int64 `locationName:"desiredvCpus" type:"integer"` // The EC2 key pair that is used for instances launched in the compute environment. Ec2KeyPair *string `locationName:"ec2KeyPair" type:"string"` // The Amazon Machine Image (AMI) ID used for instances launched in the compute // environment. ImageId *string `locationName:"imageId" type:"string"` // The Amazon ECS instance profile applied to Amazon EC2 instances in a compute // environment. You can specify the short name or full Amazon Resource Name // (ARN) of an instance profile. For example, ecsInstanceRole or arn:aws:iam::<aws_account_id>:instance-profile/ecsInstanceRole. // For more information, see Amazon ECS Instance Role (http://docs.aws.amazon.com/batch/latest/userguide/instance_IAM_role.html) // in the AWS Batch User Guide. // // InstanceRole is a required field InstanceRole *string `locationName:"instanceRole" type:"string" required:"true"` // The instances types that may be launched. You can specify instance families // to launch any instance type within those families (for example, c4 or p3), // or you can specify specific sizes within a family (such as c4.8xlarge). You // can also choose optimal to pick instance types (from the latest C, M, and // R instance families) on the fly that match the demand of your job queues. // // InstanceTypes is a required field InstanceTypes []*string `locationName:"instanceTypes" type:"list" required:"true"` // The maximum number of EC2 vCPUs that an environment can reach. // // MaxvCpus is a required field MaxvCpus *int64 `locationName:"maxvCpus" type:"integer" required:"true"` // The minimum number of EC2 vCPUs that an environment should maintain. // // MinvCpus is a required field MinvCpus *int64 `locationName:"minvCpus" type:"integer" required:"true"` // The EC2 security group that is associated with instances launched in the // compute environment. // // SecurityGroupIds is a required field SecurityGroupIds []*string `locationName:"securityGroupIds" type:"list" required:"true"` // The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied // to a SPOT compute environment. SpotIamFleetRole *string `locationName:"spotIamFleetRole" type:"string"` // The VPC subnets into which the compute resources are launched. // // Subnets is a required field Subnets []*string `locationName:"subnets" type:"list" required:"true"` // Key-value pair tags to be applied to resources that are launched in the compute // environment. Tags map[string]*string `locationName:"tags" type:"map"` // The type of compute environment. // // Type is a required field Type *string `locationName:"type" type:"string" required:"true" enum:"CRType"` // contains filtered or unexported fields }
An object representing an AWS Batch compute resource.
func (ComputeResource) GoString ¶
func (s ComputeResource) GoString() string
GoString returns the string representation
func (*ComputeResource) SetBidPercentage ¶
func (s *ComputeResource) SetBidPercentage(v int64) *ComputeResource
SetBidPercentage sets the BidPercentage field's value.
func (*ComputeResource) SetDesiredvCpus ¶
func (s *ComputeResource) SetDesiredvCpus(v int64) *ComputeResource
SetDesiredvCpus sets the DesiredvCpus field's value.
func (*ComputeResource) SetEc2KeyPair ¶
func (s *ComputeResource) SetEc2KeyPair(v string) *ComputeResource
SetEc2KeyPair sets the Ec2KeyPair field's value.
func (*ComputeResource) SetImageId ¶ added in v1.8.12
func (s *ComputeResource) SetImageId(v string) *ComputeResource
SetImageId sets the ImageId field's value.
func (*ComputeResource) SetInstanceRole ¶
func (s *ComputeResource) SetInstanceRole(v string) *ComputeResource
SetInstanceRole sets the InstanceRole field's value.
func (*ComputeResource) SetInstanceTypes ¶
func (s *ComputeResource) SetInstanceTypes(v []*string) *ComputeResource
SetInstanceTypes sets the InstanceTypes field's value.
func (*ComputeResource) SetMaxvCpus ¶
func (s *ComputeResource) SetMaxvCpus(v int64) *ComputeResource
SetMaxvCpus sets the MaxvCpus field's value.
func (*ComputeResource) SetMinvCpus ¶
func (s *ComputeResource) SetMinvCpus(v int64) *ComputeResource
SetMinvCpus sets the MinvCpus field's value.
func (*ComputeResource) SetSecurityGroupIds ¶
func (s *ComputeResource) SetSecurityGroupIds(v []*string) *ComputeResource
SetSecurityGroupIds sets the SecurityGroupIds field's value.
func (*ComputeResource) SetSpotIamFleetRole ¶
func (s *ComputeResource) SetSpotIamFleetRole(v string) *ComputeResource
SetSpotIamFleetRole sets the SpotIamFleetRole field's value.
func (*ComputeResource) SetSubnets ¶
func (s *ComputeResource) SetSubnets(v []*string) *ComputeResource
SetSubnets sets the Subnets field's value.
func (*ComputeResource) SetTags ¶
func (s *ComputeResource) SetTags(v map[string]*string) *ComputeResource
SetTags sets the Tags field's value.
func (*ComputeResource) SetType ¶
func (s *ComputeResource) SetType(v string) *ComputeResource
SetType sets the Type field's value.
func (ComputeResource) String ¶
func (s ComputeResource) String() string
String returns the string representation
func (*ComputeResource) Validate ¶
func (s *ComputeResource) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ComputeResourceUpdate ¶
type ComputeResourceUpdate struct { // The desired number of EC2 vCPUS in the compute environment. DesiredvCpus *int64 `locationName:"desiredvCpus" type:"integer"` // The maximum number of EC2 vCPUs that an environment can reach. MaxvCpus *int64 `locationName:"maxvCpus" type:"integer"` // The minimum number of EC2 vCPUs that an environment should maintain. MinvCpus *int64 `locationName:"minvCpus" type:"integer"` // contains filtered or unexported fields }
An object representing the attributes of a compute environment that can be updated.
func (ComputeResourceUpdate) GoString ¶
func (s ComputeResourceUpdate) GoString() string
GoString returns the string representation
func (*ComputeResourceUpdate) SetDesiredvCpus ¶
func (s *ComputeResourceUpdate) SetDesiredvCpus(v int64) *ComputeResourceUpdate
SetDesiredvCpus sets the DesiredvCpus field's value.
func (*ComputeResourceUpdate) SetMaxvCpus ¶
func (s *ComputeResourceUpdate) SetMaxvCpus(v int64) *ComputeResourceUpdate
SetMaxvCpus sets the MaxvCpus field's value.
func (*ComputeResourceUpdate) SetMinvCpus ¶
func (s *ComputeResourceUpdate) SetMinvCpus(v int64) *ComputeResourceUpdate
SetMinvCpus sets the MinvCpus field's value.
func (ComputeResourceUpdate) String ¶
func (s ComputeResourceUpdate) String() string
String returns the string representation
type ContainerDetail ¶
type ContainerDetail struct { // The command that is passed to the container. Command []*string `locationName:"command" type:"list"` // The Amazon Resource Name (ARN) of the container instance on which the container // is running. ContainerInstanceArn *string `locationName:"containerInstanceArn" type:"string"` // The environment variables to pass to a container. // // Environment variables must not start with AWS_BATCH; this naming convention // is reserved for variables that are set by the AWS Batch service. Environment []*KeyValuePair `locationName:"environment" type:"list"` // The exit code to return upon completion. ExitCode *int64 `locationName:"exitCode" type:"integer"` // The image used to start the container. Image *string `locationName:"image" type:"string"` // The Amazon Resource Name (ARN) associated with the job upon execution. JobRoleArn *string `locationName:"jobRoleArn" type:"string"` // The name of the CloudWatch Logs log stream associated with the container. // The log group for AWS Batch jobs is /aws/batch/job. Each container attempt // receives a log stream name when they reach the RUNNING status. LogStreamName *string `locationName:"logStreamName" type:"string"` // The number of MiB of memory reserved for the job. Memory *int64 `locationName:"memory" type:"integer"` // The mount points for data volumes in your container. MountPoints []*MountPoint `locationName:"mountPoints" type:"list"` // When this parameter is true, the container is given elevated privileges on // the host container instance (similar to the root user). Privileged *bool `locationName:"privileged" type:"boolean"` // When this parameter is true, the container is given read-only access to its // root file system. ReadonlyRootFilesystem *bool `locationName:"readonlyRootFilesystem" type:"boolean"` // A short (255 max characters) human-readable string to provide additional // details about a running or stopped container. Reason *string `locationName:"reason" type:"string"` // The Amazon Resource Name (ARN) of the Amazon ECS task that is associated // with the container job. Each container attempt receives a task ARN when they // reach the STARTING status. TaskArn *string `locationName:"taskArn" type:"string"` // A list of ulimit values to set in the container. Ulimits []*Ulimit `locationName:"ulimits" type:"list"` // The user name to use inside the container. User *string `locationName:"user" type:"string"` // The number of VCPUs allocated for the job. Vcpus *int64 `locationName:"vcpus" type:"integer"` // A list of volumes associated with the job. Volumes []*Volume `locationName:"volumes" type:"list"` // contains filtered or unexported fields }
An object representing the details of a container that is part of a job.
func (ContainerDetail) GoString ¶
func (s ContainerDetail) GoString() string
GoString returns the string representation
func (*ContainerDetail) SetCommand ¶
func (s *ContainerDetail) SetCommand(v []*string) *ContainerDetail
SetCommand sets the Command field's value.
func (*ContainerDetail) SetContainerInstanceArn ¶
func (s *ContainerDetail) SetContainerInstanceArn(v string) *ContainerDetail
SetContainerInstanceArn sets the ContainerInstanceArn field's value.
func (*ContainerDetail) SetEnvironment ¶
func (s *ContainerDetail) SetEnvironment(v []*KeyValuePair) *ContainerDetail
SetEnvironment sets the Environment field's value.
func (*ContainerDetail) SetExitCode ¶
func (s *ContainerDetail) SetExitCode(v int64) *ContainerDetail
SetExitCode sets the ExitCode field's value.
func (*ContainerDetail) SetImage ¶
func (s *ContainerDetail) SetImage(v string) *ContainerDetail
SetImage sets the Image field's value.
func (*ContainerDetail) SetJobRoleArn ¶
func (s *ContainerDetail) SetJobRoleArn(v string) *ContainerDetail
SetJobRoleArn sets the JobRoleArn field's value.
func (*ContainerDetail) SetLogStreamName ¶ added in v1.10.25
func (s *ContainerDetail) SetLogStreamName(v string) *ContainerDetail
SetLogStreamName sets the LogStreamName field's value.
func (*ContainerDetail) SetMemory ¶
func (s *ContainerDetail) SetMemory(v int64) *ContainerDetail
SetMemory sets the Memory field's value.
func (*ContainerDetail) SetMountPoints ¶
func (s *ContainerDetail) SetMountPoints(v []*MountPoint) *ContainerDetail
SetMountPoints sets the MountPoints field's value.
func (*ContainerDetail) SetPrivileged ¶
func (s *ContainerDetail) SetPrivileged(v bool) *ContainerDetail
SetPrivileged sets the Privileged field's value.
func (*ContainerDetail) SetReadonlyRootFilesystem ¶
func (s *ContainerDetail) SetReadonlyRootFilesystem(v bool) *ContainerDetail
SetReadonlyRootFilesystem sets the ReadonlyRootFilesystem field's value.
func (*ContainerDetail) SetReason ¶
func (s *ContainerDetail) SetReason(v string) *ContainerDetail
SetReason sets the Reason field's value.
func (*ContainerDetail) SetTaskArn ¶ added in v1.8.5
func (s *ContainerDetail) SetTaskArn(v string) *ContainerDetail
SetTaskArn sets the TaskArn field's value.
func (*ContainerDetail) SetUlimits ¶
func (s *ContainerDetail) SetUlimits(v []*Ulimit) *ContainerDetail
SetUlimits sets the Ulimits field's value.
func (*ContainerDetail) SetUser ¶
func (s *ContainerDetail) SetUser(v string) *ContainerDetail
SetUser sets the User field's value.
func (*ContainerDetail) SetVcpus ¶
func (s *ContainerDetail) SetVcpus(v int64) *ContainerDetail
SetVcpus sets the Vcpus field's value.
func (*ContainerDetail) SetVolumes ¶
func (s *ContainerDetail) SetVolumes(v []*Volume) *ContainerDetail
SetVolumes sets the Volumes field's value.
func (ContainerDetail) String ¶
func (s ContainerDetail) String() string
String returns the string representation
type ContainerOverrides ¶
type ContainerOverrides struct { // The command to send to the container that overrides the default command from // the Docker image or the job definition. Command []*string `locationName:"command" type:"list"` // The environment variables to send to the container. You can add new environment // variables, which are added to the container at launch, or you can override // the existing environment variables from the Docker image or the job definition. // // Environment variables must not start with AWS_BATCH; this naming convention // is reserved for variables that are set by the AWS Batch service. Environment []*KeyValuePair `locationName:"environment" type:"list"` // The number of MiB of memory reserved for the job. This value overrides the // value set in the job definition. Memory *int64 `locationName:"memory" type:"integer"` // The number of vCPUs to reserve for the container. This value overrides the // value set in the job definition. Vcpus *int64 `locationName:"vcpus" type:"integer"` // contains filtered or unexported fields }
The overrides that should be sent to a container.
func (ContainerOverrides) GoString ¶
func (s ContainerOverrides) GoString() string
GoString returns the string representation
func (*ContainerOverrides) SetCommand ¶
func (s *ContainerOverrides) SetCommand(v []*string) *ContainerOverrides
SetCommand sets the Command field's value.
func (*ContainerOverrides) SetEnvironment ¶
func (s *ContainerOverrides) SetEnvironment(v []*KeyValuePair) *ContainerOverrides
SetEnvironment sets the Environment field's value.
func (*ContainerOverrides) SetMemory ¶
func (s *ContainerOverrides) SetMemory(v int64) *ContainerOverrides
SetMemory sets the Memory field's value.
func (*ContainerOverrides) SetVcpus ¶
func (s *ContainerOverrides) SetVcpus(v int64) *ContainerOverrides
SetVcpus sets the Vcpus field's value.
func (ContainerOverrides) String ¶
func (s ContainerOverrides) String() string
String returns the string representation
type ContainerProperties ¶
type ContainerProperties struct { // The command that is passed to the container. This parameter maps to Cmd in // the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/) // and the COMMAND parameter to docker run (https://docs.docker.com/engine/reference/run/). // For more information, see https://docs.docker.com/engine/reference/builder/#cmd // (https://docs.docker.com/engine/reference/builder/#cmd). Command []*string `locationName:"command" type:"list"` // The environment variables to pass to a container. This parameter maps to // Env in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/) // and the --env option to docker run (https://docs.docker.com/engine/reference/run/). // // We do not recommend using plaintext environment variables for sensitive information, // such as credential data. // // Environment variables must not start with AWS_BATCH; this naming convention // is reserved for variables that are set by the AWS Batch service. Environment []*KeyValuePair `locationName:"environment" type:"list"` // The image used to start a container. This string is passed directly to the // Docker daemon. Images in the Docker Hub registry are available by default. // Other repositories are specified with repository-url/image:tag. Up to 255 // letters (uppercase and lowercase), numbers, hyphens, underscores, colons, // periods, forward slashes, and number signs are allowed. This parameter maps // to Image in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/) // and the IMAGE parameter of docker run (https://docs.docker.com/engine/reference/run/). // // * Images in Amazon ECR repositories use the full registry and repository // URI (for example, 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>). // // // * Images in official repositories on Docker Hub use a single name (for // example, ubuntu or mongo). // // * Images in other repositories on Docker Hub are qualified with an organization // name (for example, amazon/amazon-ecs-agent). // // * Images in other online repositories are qualified further by a domain // name (for example, quay.io/assemblyline/ubuntu). // // Image is a required field Image *string `locationName:"image" type:"string" required:"true"` // The Amazon Resource Name (ARN) of the IAM role that the container can assume // for AWS permissions. JobRoleArn *string `locationName:"jobRoleArn" type:"string"` // The hard limit (in MiB) of memory to present to the container. If your container // attempts to exceed the memory specified here, the container is killed. This // parameter maps to Memory in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/) // and the --memory option to docker run (https://docs.docker.com/engine/reference/run/). // You must specify at least 4 MiB of memory for a job. // // If you are trying to maximize your resource utilization by providing your // jobs as much memory as possible for a particular instance type, see Memory // Management (http://docs.aws.amazon.com/batch/latest/userguide/memory-management.html) // in the AWS Batch User Guide. // // Memory is a required field Memory *int64 `locationName:"memory" type:"integer" required:"true"` // The mount points for data volumes in your container. This parameter maps // to Volumes in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/) // and the --volume option to docker run (https://docs.docker.com/engine/reference/run/). MountPoints []*MountPoint `locationName:"mountPoints" type:"list"` // When this parameter is true, the container is given elevated privileges on // the host container instance (similar to the root user). This parameter maps // to Privileged in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/) // and the --privileged option to docker run (https://docs.docker.com/engine/reference/run/). Privileged *bool `locationName:"privileged" type:"boolean"` // When this parameter is true, the container is given read-only access to its // root file system. This parameter maps to ReadonlyRootfs in the Create a container // (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/) // and the --read-only option to docker run. ReadonlyRootFilesystem *bool `locationName:"readonlyRootFilesystem" type:"boolean"` // A list of ulimits to set in the container. This parameter maps to Ulimits // in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/) // and the --ulimit option to docker run (https://docs.docker.com/engine/reference/run/). Ulimits []*Ulimit `locationName:"ulimits" type:"list"` // The user name to use inside the container. This parameter maps to User in // the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/) // and the --user option to docker run (https://docs.docker.com/engine/reference/run/). User *string `locationName:"user" type:"string"` // The number of vCPUs reserved for the container. This parameter maps to CpuShares // in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/) // and the --cpu-shares option to docker run (https://docs.docker.com/engine/reference/run/). // Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one // vCPU. // // Vcpus is a required field Vcpus *int64 `locationName:"vcpus" type:"integer" required:"true"` // A list of data volumes used in a job. Volumes []*Volume `locationName:"volumes" type:"list"` // contains filtered or unexported fields }
Container properties are used in job definitions to describe the container that is launched as part of a job.
func (ContainerProperties) GoString ¶
func (s ContainerProperties) GoString() string
GoString returns the string representation
func (*ContainerProperties) SetCommand ¶
func (s *ContainerProperties) SetCommand(v []*string) *ContainerProperties
SetCommand sets the Command field's value.
func (*ContainerProperties) SetEnvironment ¶
func (s *ContainerProperties) SetEnvironment(v []*KeyValuePair) *ContainerProperties
SetEnvironment sets the Environment field's value.
func (*ContainerProperties) SetImage ¶
func (s *ContainerProperties) SetImage(v string) *ContainerProperties
SetImage sets the Image field's value.
func (*ContainerProperties) SetJobRoleArn ¶
func (s *ContainerProperties) SetJobRoleArn(v string) *ContainerProperties
SetJobRoleArn sets the JobRoleArn field's value.
func (*ContainerProperties) SetMemory ¶
func (s *ContainerProperties) SetMemory(v int64) *ContainerProperties
SetMemory sets the Memory field's value.
func (*ContainerProperties) SetMountPoints ¶
func (s *ContainerProperties) SetMountPoints(v []*MountPoint) *ContainerProperties
SetMountPoints sets the MountPoints field's value.
func (*ContainerProperties) SetPrivileged ¶
func (s *ContainerProperties) SetPrivileged(v bool) *ContainerProperties
SetPrivileged sets the Privileged field's value.
func (*ContainerProperties) SetReadonlyRootFilesystem ¶
func (s *ContainerProperties) SetReadonlyRootFilesystem(v bool) *ContainerProperties
SetReadonlyRootFilesystem sets the ReadonlyRootFilesystem field's value.
func (*ContainerProperties) SetUlimits ¶
func (s *ContainerProperties) SetUlimits(v []*Ulimit) *ContainerProperties
SetUlimits sets the Ulimits field's value.
func (*ContainerProperties) SetUser ¶
func (s *ContainerProperties) SetUser(v string) *ContainerProperties
SetUser sets the User field's value.
func (*ContainerProperties) SetVcpus ¶
func (s *ContainerProperties) SetVcpus(v int64) *ContainerProperties
SetVcpus sets the Vcpus field's value.
func (*ContainerProperties) SetVolumes ¶
func (s *ContainerProperties) SetVolumes(v []*Volume) *ContainerProperties
SetVolumes sets the Volumes field's value.
func (ContainerProperties) String ¶
func (s ContainerProperties) String() string
String returns the string representation
func (*ContainerProperties) Validate ¶
func (s *ContainerProperties) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ContainerSummary ¶ added in v1.12.35
type ContainerSummary struct { // The exit code to return upon completion. ExitCode *int64 `locationName:"exitCode" type:"integer"` // A short (255 max characters) human-readable string to provide additional // details about a running or stopped container. Reason *string `locationName:"reason" type:"string"` // contains filtered or unexported fields }
An object representing summary details of a container within a job.
func (ContainerSummary) GoString ¶ added in v1.12.35
func (s ContainerSummary) GoString() string
GoString returns the string representation
func (*ContainerSummary) SetExitCode ¶ added in v1.12.35
func (s *ContainerSummary) SetExitCode(v int64) *ContainerSummary
SetExitCode sets the ExitCode field's value.
func (*ContainerSummary) SetReason ¶ added in v1.12.35
func (s *ContainerSummary) SetReason(v string) *ContainerSummary
SetReason sets the Reason field's value.
func (ContainerSummary) String ¶ added in v1.12.35
func (s ContainerSummary) String() string
String returns the string representation
type CreateComputeEnvironmentInput ¶
type CreateComputeEnvironmentInput struct { // The name for your compute environment. Up to 128 letters (uppercase and lowercase), // numbers, hyphens, and underscores are allowed. // // ComputeEnvironmentName is a required field ComputeEnvironmentName *string `locationName:"computeEnvironmentName" type:"string" required:"true"` // Details of the compute resources managed by the compute environment. This // parameter is required for managed compute environments. ComputeResources *ComputeResource `locationName:"computeResources" type:"structure"` // The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch // to make calls to other AWS services on your behalf. // // If your specified role has a path other than /, then you must either specify // the full role ARN (this is recommended) or prefix the role name with the // path. // // Depending on how you created your AWS Batch service role, its ARN may contain // the service-role path prefix. When you only specify the name of the service // role, AWS Batch assumes that your ARN does not use the service-role path // prefix. Because of this, we recommend that you specify the full ARN of your // service role when you create compute environments. // // ServiceRole is a required field ServiceRole *string `locationName:"serviceRole" type:"string" required:"true"` // The state of the compute environment. If the state is ENABLED, then the compute // environment accepts jobs from a queue and can scale out automatically based // on queues. State *string `locationName:"state" type:"string" enum:"CEState"` // The type of the compute environment. // // Type is a required field Type *string `locationName:"type" type:"string" required:"true" enum:"CEType"` // contains filtered or unexported fields }
func (CreateComputeEnvironmentInput) GoString ¶
func (s CreateComputeEnvironmentInput) GoString() string
GoString returns the string representation
func (*CreateComputeEnvironmentInput) SetComputeEnvironmentName ¶
func (s *CreateComputeEnvironmentInput) SetComputeEnvironmentName(v string) *CreateComputeEnvironmentInput
SetComputeEnvironmentName sets the ComputeEnvironmentName field's value.
func (*CreateComputeEnvironmentInput) SetComputeResources ¶
func (s *CreateComputeEnvironmentInput) SetComputeResources(v *ComputeResource) *CreateComputeEnvironmentInput
SetComputeResources sets the ComputeResources field's value.
func (*CreateComputeEnvironmentInput) SetServiceRole ¶
func (s *CreateComputeEnvironmentInput) SetServiceRole(v string) *CreateComputeEnvironmentInput
SetServiceRole sets the ServiceRole field's value.
func (*CreateComputeEnvironmentInput) SetState ¶
func (s *CreateComputeEnvironmentInput) SetState(v string) *CreateComputeEnvironmentInput
SetState sets the State field's value.
func (*CreateComputeEnvironmentInput) SetType ¶
func (s *CreateComputeEnvironmentInput) SetType(v string) *CreateComputeEnvironmentInput
SetType sets the Type field's value.
func (CreateComputeEnvironmentInput) String ¶
func (s CreateComputeEnvironmentInput) String() string
String returns the string representation
func (*CreateComputeEnvironmentInput) Validate ¶
func (s *CreateComputeEnvironmentInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateComputeEnvironmentOutput ¶
type CreateComputeEnvironmentOutput struct { // The Amazon Resource Name (ARN) of the compute environment. ComputeEnvironmentArn *string `locationName:"computeEnvironmentArn" type:"string"` // The name of the compute environment. ComputeEnvironmentName *string `locationName:"computeEnvironmentName" type:"string"` // contains filtered or unexported fields }
func (CreateComputeEnvironmentOutput) GoString ¶
func (s CreateComputeEnvironmentOutput) GoString() string
GoString returns the string representation
func (*CreateComputeEnvironmentOutput) SetComputeEnvironmentArn ¶
func (s *CreateComputeEnvironmentOutput) SetComputeEnvironmentArn(v string) *CreateComputeEnvironmentOutput
SetComputeEnvironmentArn sets the ComputeEnvironmentArn field's value.
func (*CreateComputeEnvironmentOutput) SetComputeEnvironmentName ¶
func (s *CreateComputeEnvironmentOutput) SetComputeEnvironmentName(v string) *CreateComputeEnvironmentOutput
SetComputeEnvironmentName sets the ComputeEnvironmentName field's value.
func (CreateComputeEnvironmentOutput) String ¶
func (s CreateComputeEnvironmentOutput) String() string
String returns the string representation
type CreateJobQueueInput ¶
type CreateJobQueueInput struct { // The set of compute environments mapped to a job queue and their order relative // to each other. The job scheduler uses this parameter to determine which compute // environment should execute a given job. Compute environments must be in the // VALID state before you can associate them with a job queue. You can associate // up to three compute environments with a job queue. // // ComputeEnvironmentOrder is a required field ComputeEnvironmentOrder []*ComputeEnvironmentOrder `locationName:"computeEnvironmentOrder" type:"list" required:"true"` // The name of the job queue. // // JobQueueName is a required field JobQueueName *string `locationName:"jobQueueName" type:"string" required:"true"` // The priority of the job queue. Job queues with a higher priority (or a higher // integer value for the priority parameter) are evaluated first when associated // with same compute environment. Priority is determined in descending order, // for example, a job queue with a priority value of 10 is given scheduling // preference over a job queue with a priority value of 1. // // Priority is a required field Priority *int64 `locationName:"priority" type:"integer" required:"true"` // The state of the job queue. If the job queue state is ENABLED, it is able // to accept jobs. State *string `locationName:"state" type:"string" enum:"JQState"` // contains filtered or unexported fields }
func (CreateJobQueueInput) GoString ¶
func (s CreateJobQueueInput) GoString() string
GoString returns the string representation
func (*CreateJobQueueInput) SetComputeEnvironmentOrder ¶
func (s *CreateJobQueueInput) SetComputeEnvironmentOrder(v []*ComputeEnvironmentOrder) *CreateJobQueueInput
SetComputeEnvironmentOrder sets the ComputeEnvironmentOrder field's value.
func (*CreateJobQueueInput) SetJobQueueName ¶
func (s *CreateJobQueueInput) SetJobQueueName(v string) *CreateJobQueueInput
SetJobQueueName sets the JobQueueName field's value.
func (*CreateJobQueueInput) SetPriority ¶
func (s *CreateJobQueueInput) SetPriority(v int64) *CreateJobQueueInput
SetPriority sets the Priority field's value.
func (*CreateJobQueueInput) SetState ¶
func (s *CreateJobQueueInput) SetState(v string) *CreateJobQueueInput
SetState sets the State field's value.
func (CreateJobQueueInput) String ¶
func (s CreateJobQueueInput) String() string
String returns the string representation
func (*CreateJobQueueInput) Validate ¶
func (s *CreateJobQueueInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateJobQueueOutput ¶
type CreateJobQueueOutput struct { // The Amazon Resource Name (ARN) of the job queue. // // JobQueueArn is a required field JobQueueArn *string `locationName:"jobQueueArn" type:"string" required:"true"` // The name of the job queue. // // JobQueueName is a required field JobQueueName *string `locationName:"jobQueueName" type:"string" required:"true"` // contains filtered or unexported fields }
func (CreateJobQueueOutput) GoString ¶
func (s CreateJobQueueOutput) GoString() string
GoString returns the string representation
func (*CreateJobQueueOutput) SetJobQueueArn ¶
func (s *CreateJobQueueOutput) SetJobQueueArn(v string) *CreateJobQueueOutput
SetJobQueueArn sets the JobQueueArn field's value.
func (*CreateJobQueueOutput) SetJobQueueName ¶
func (s *CreateJobQueueOutput) SetJobQueueName(v string) *CreateJobQueueOutput
SetJobQueueName sets the JobQueueName field's value.
func (CreateJobQueueOutput) String ¶
func (s CreateJobQueueOutput) String() string
String returns the string representation
type DeleteComputeEnvironmentInput ¶
type DeleteComputeEnvironmentInput struct { // The name or Amazon Resource Name (ARN) of the compute environment to delete. // // ComputeEnvironment is a required field ComputeEnvironment *string `locationName:"computeEnvironment" type:"string" required:"true"` // contains filtered or unexported fields }
func (DeleteComputeEnvironmentInput) GoString ¶
func (s DeleteComputeEnvironmentInput) GoString() string
GoString returns the string representation
func (*DeleteComputeEnvironmentInput) SetComputeEnvironment ¶
func (s *DeleteComputeEnvironmentInput) SetComputeEnvironment(v string) *DeleteComputeEnvironmentInput
SetComputeEnvironment sets the ComputeEnvironment field's value.
func (DeleteComputeEnvironmentInput) String ¶
func (s DeleteComputeEnvironmentInput) String() string
String returns the string representation
func (*DeleteComputeEnvironmentInput) Validate ¶
func (s *DeleteComputeEnvironmentInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteComputeEnvironmentOutput ¶
type DeleteComputeEnvironmentOutput struct {
// contains filtered or unexported fields
}
func (DeleteComputeEnvironmentOutput) GoString ¶
func (s DeleteComputeEnvironmentOutput) GoString() string
GoString returns the string representation
func (DeleteComputeEnvironmentOutput) String ¶
func (s DeleteComputeEnvironmentOutput) String() string
String returns the string representation
type DeleteJobQueueInput ¶
type DeleteJobQueueInput struct { // The short name or full Amazon Resource Name (ARN) of the queue to delete. // // JobQueue is a required field JobQueue *string `locationName:"jobQueue" type:"string" required:"true"` // contains filtered or unexported fields }
func (DeleteJobQueueInput) GoString ¶
func (s DeleteJobQueueInput) GoString() string
GoString returns the string representation
func (*DeleteJobQueueInput) SetJobQueue ¶
func (s *DeleteJobQueueInput) SetJobQueue(v string) *DeleteJobQueueInput
SetJobQueue sets the JobQueue field's value.
func (DeleteJobQueueInput) String ¶
func (s DeleteJobQueueInput) String() string
String returns the string representation
func (*DeleteJobQueueInput) Validate ¶
func (s *DeleteJobQueueInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteJobQueueOutput ¶
type DeleteJobQueueOutput struct {
// contains filtered or unexported fields
}
func (DeleteJobQueueOutput) GoString ¶
func (s DeleteJobQueueOutput) GoString() string
GoString returns the string representation
func (DeleteJobQueueOutput) String ¶
func (s DeleteJobQueueOutput) String() string
String returns the string representation
type DeregisterJobDefinitionInput ¶
type DeregisterJobDefinitionInput struct { // The name and revision (name:revision) or full Amazon Resource Name (ARN) // of the job definition to deregister. // // JobDefinition is a required field JobDefinition *string `locationName:"jobDefinition" type:"string" required:"true"` // contains filtered or unexported fields }
func (DeregisterJobDefinitionInput) GoString ¶
func (s DeregisterJobDefinitionInput) GoString() string
GoString returns the string representation
func (*DeregisterJobDefinitionInput) SetJobDefinition ¶
func (s *DeregisterJobDefinitionInput) SetJobDefinition(v string) *DeregisterJobDefinitionInput
SetJobDefinition sets the JobDefinition field's value.
func (DeregisterJobDefinitionInput) String ¶
func (s DeregisterJobDefinitionInput) String() string
String returns the string representation
func (*DeregisterJobDefinitionInput) Validate ¶
func (s *DeregisterJobDefinitionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeregisterJobDefinitionOutput ¶
type DeregisterJobDefinitionOutput struct {
// contains filtered or unexported fields
}
func (DeregisterJobDefinitionOutput) GoString ¶
func (s DeregisterJobDefinitionOutput) GoString() string
GoString returns the string representation
func (DeregisterJobDefinitionOutput) String ¶
func (s DeregisterJobDefinitionOutput) String() string
String returns the string representation
type DescribeComputeEnvironmentsInput ¶
type DescribeComputeEnvironmentsInput struct { // A list of up to 100 compute environment names or full Amazon Resource Name // (ARN) entries. ComputeEnvironments []*string `locationName:"computeEnvironments" type:"list"` // The maximum number of cluster results returned by DescribeComputeEnvironments // in paginated output. When this parameter is used, DescribeComputeEnvironments // only returns maxResults results in a single page along with a nextToken response // element. The remaining results of the initial request can be seen by sending // another DescribeComputeEnvironments request with the returned nextToken value. // This value can be between 1 and 100. If this parameter is not used, then // DescribeComputeEnvironments returns up to 100 results and a nextToken value // if applicable. MaxResults *int64 `locationName:"maxResults" type:"integer"` // The nextToken value returned from a previous paginated DescribeComputeEnvironments // request where maxResults was used and the results exceeded the value of that // parameter. Pagination continues from the end of the previous results that // returned the nextToken value. This value is null when there are no more results // to return. // // This token should be treated as an opaque identifier that is only used to // retrieve the next items in a list and not for other programmatic purposes. NextToken *string `locationName:"nextToken" type:"string"` // contains filtered or unexported fields }
func (DescribeComputeEnvironmentsInput) GoString ¶
func (s DescribeComputeEnvironmentsInput) GoString() string
GoString returns the string representation
func (*DescribeComputeEnvironmentsInput) SetComputeEnvironments ¶
func (s *DescribeComputeEnvironmentsInput) SetComputeEnvironments(v []*string) *DescribeComputeEnvironmentsInput
SetComputeEnvironments sets the ComputeEnvironments field's value.
func (*DescribeComputeEnvironmentsInput) SetMaxResults ¶
func (s *DescribeComputeEnvironmentsInput) SetMaxResults(v int64) *DescribeComputeEnvironmentsInput
SetMaxResults sets the MaxResults field's value.
func (*DescribeComputeEnvironmentsInput) SetNextToken ¶
func (s *DescribeComputeEnvironmentsInput) SetNextToken(v string) *DescribeComputeEnvironmentsInput
SetNextToken sets the NextToken field's value.
func (DescribeComputeEnvironmentsInput) String ¶
func (s DescribeComputeEnvironmentsInput) String() string
String returns the string representation
type DescribeComputeEnvironmentsOutput ¶
type DescribeComputeEnvironmentsOutput struct { // The list of compute environments. ComputeEnvironments []*ComputeEnvironmentDetail `locationName:"computeEnvironments" type:"list"` // The nextToken value to include in a future DescribeComputeEnvironments request. // When the results of a DescribeJobDefinitions request exceed maxResults, this // value can be used to retrieve the next page of results. This value is null // when there are no more results to return. NextToken *string `locationName:"nextToken" type:"string"` // contains filtered or unexported fields }
func (DescribeComputeEnvironmentsOutput) GoString ¶
func (s DescribeComputeEnvironmentsOutput) GoString() string
GoString returns the string representation
func (*DescribeComputeEnvironmentsOutput) SetComputeEnvironments ¶
func (s *DescribeComputeEnvironmentsOutput) SetComputeEnvironments(v []*ComputeEnvironmentDetail) *DescribeComputeEnvironmentsOutput
SetComputeEnvironments sets the ComputeEnvironments field's value.
func (*DescribeComputeEnvironmentsOutput) SetNextToken ¶
func (s *DescribeComputeEnvironmentsOutput) SetNextToken(v string) *DescribeComputeEnvironmentsOutput
SetNextToken sets the NextToken field's value.
func (DescribeComputeEnvironmentsOutput) String ¶
func (s DescribeComputeEnvironmentsOutput) String() string
String returns the string representation
type DescribeJobDefinitionsInput ¶
type DescribeJobDefinitionsInput struct { // The name of the job definition to describe. JobDefinitionName *string `locationName:"jobDefinitionName" type:"string"` // A space-separated list of up to 100 job definition names or full Amazon Resource // Name (ARN) entries. JobDefinitions []*string `locationName:"jobDefinitions" type:"list"` // The maximum number of results returned by DescribeJobDefinitions in paginated // output. When this parameter is used, DescribeJobDefinitions only returns // maxResults results in a single page along with a nextToken response element. // The remaining results of the initial request can be seen by sending another // DescribeJobDefinitions request with the returned nextToken value. This value // can be between 1 and 100. If this parameter is not used, then DescribeJobDefinitions // returns up to 100 results and a nextToken value if applicable. MaxResults *int64 `locationName:"maxResults" type:"integer"` // The nextToken value returned from a previous paginated DescribeJobDefinitions // request where maxResults was used and the results exceeded the value of that // parameter. Pagination continues from the end of the previous results that // returned the nextToken value. This value is null when there are no more results // to return. // // This token should be treated as an opaque identifier that is only used to // retrieve the next items in a list and not for other programmatic purposes. NextToken *string `locationName:"nextToken" type:"string"` // The status with which to filter job definitions. Status *string `locationName:"status" type:"string"` // contains filtered or unexported fields }
func (DescribeJobDefinitionsInput) GoString ¶
func (s DescribeJobDefinitionsInput) GoString() string
GoString returns the string representation
func (*DescribeJobDefinitionsInput) SetJobDefinitionName ¶
func (s *DescribeJobDefinitionsInput) SetJobDefinitionName(v string) *DescribeJobDefinitionsInput
SetJobDefinitionName sets the JobDefinitionName field's value.
func (*DescribeJobDefinitionsInput) SetJobDefinitions ¶
func (s *DescribeJobDefinitionsInput) SetJobDefinitions(v []*string) *DescribeJobDefinitionsInput
SetJobDefinitions sets the JobDefinitions field's value.
func (*DescribeJobDefinitionsInput) SetMaxResults ¶
func (s *DescribeJobDefinitionsInput) SetMaxResults(v int64) *DescribeJobDefinitionsInput
SetMaxResults sets the MaxResults field's value.
func (*DescribeJobDefinitionsInput) SetNextToken ¶
func (s *DescribeJobDefinitionsInput) SetNextToken(v string) *DescribeJobDefinitionsInput
SetNextToken sets the NextToken field's value.
func (*DescribeJobDefinitionsInput) SetStatus ¶
func (s *DescribeJobDefinitionsInput) SetStatus(v string) *DescribeJobDefinitionsInput
SetStatus sets the Status field's value.
func (DescribeJobDefinitionsInput) String ¶
func (s DescribeJobDefinitionsInput) String() string
String returns the string representation
type DescribeJobDefinitionsOutput ¶
type DescribeJobDefinitionsOutput struct { // The list of job definitions. JobDefinitions []*JobDefinition `locationName:"jobDefinitions" type:"list"` // The nextToken value to include in a future DescribeJobDefinitions request. // When the results of a DescribeJobDefinitions request exceed maxResults, this // value can be used to retrieve the next page of results. This value is null // when there are no more results to return. NextToken *string `locationName:"nextToken" type:"string"` // contains filtered or unexported fields }
func (DescribeJobDefinitionsOutput) GoString ¶
func (s DescribeJobDefinitionsOutput) GoString() string
GoString returns the string representation
func (*DescribeJobDefinitionsOutput) SetJobDefinitions ¶
func (s *DescribeJobDefinitionsOutput) SetJobDefinitions(v []*JobDefinition) *DescribeJobDefinitionsOutput
SetJobDefinitions sets the JobDefinitions field's value.
func (*DescribeJobDefinitionsOutput) SetNextToken ¶
func (s *DescribeJobDefinitionsOutput) SetNextToken(v string) *DescribeJobDefinitionsOutput
SetNextToken sets the NextToken field's value.
func (DescribeJobDefinitionsOutput) String ¶
func (s DescribeJobDefinitionsOutput) String() string
String returns the string representation
type DescribeJobQueuesInput ¶
type DescribeJobQueuesInput struct { // A list of up to 100 queue names or full queue Amazon Resource Name (ARN) // entries. JobQueues []*string `locationName:"jobQueues" type:"list"` // The maximum number of results returned by DescribeJobQueues in paginated // output. When this parameter is used, DescribeJobQueues only returns maxResults // results in a single page along with a nextToken response element. The remaining // results of the initial request can be seen by sending another DescribeJobQueues // request with the returned nextToken value. This value can be between 1 and // 100. If this parameter is not used, then DescribeJobQueues returns up to // 100 results and a nextToken value if applicable. MaxResults *int64 `locationName:"maxResults" type:"integer"` // The nextToken value returned from a previous paginated DescribeJobQueues // request where maxResults was used and the results exceeded the value of that // parameter. Pagination continues from the end of the previous results that // returned the nextToken value. This value is null when there are no more results // to return. // // This token should be treated as an opaque identifier that is only used to // retrieve the next items in a list and not for other programmatic purposes. NextToken *string `locationName:"nextToken" type:"string"` // contains filtered or unexported fields }
func (DescribeJobQueuesInput) GoString ¶
func (s DescribeJobQueuesInput) GoString() string
GoString returns the string representation
func (*DescribeJobQueuesInput) SetJobQueues ¶
func (s *DescribeJobQueuesInput) SetJobQueues(v []*string) *DescribeJobQueuesInput
SetJobQueues sets the JobQueues field's value.
func (*DescribeJobQueuesInput) SetMaxResults ¶
func (s *DescribeJobQueuesInput) SetMaxResults(v int64) *DescribeJobQueuesInput
SetMaxResults sets the MaxResults field's value.
func (*DescribeJobQueuesInput) SetNextToken ¶
func (s *DescribeJobQueuesInput) SetNextToken(v string) *DescribeJobQueuesInput
SetNextToken sets the NextToken field's value.
func (DescribeJobQueuesInput) String ¶
func (s DescribeJobQueuesInput) String() string
String returns the string representation
type DescribeJobQueuesOutput ¶
type DescribeJobQueuesOutput struct { // The list of job queues. JobQueues []*JobQueueDetail `locationName:"jobQueues" type:"list"` // The nextToken value to include in a future DescribeJobQueues request. When // the results of a DescribeJobQueues request exceed maxResults, this value // can be used to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string `locationName:"nextToken" type:"string"` // contains filtered or unexported fields }
func (DescribeJobQueuesOutput) GoString ¶
func (s DescribeJobQueuesOutput) GoString() string
GoString returns the string representation
func (*DescribeJobQueuesOutput) SetJobQueues ¶
func (s *DescribeJobQueuesOutput) SetJobQueues(v []*JobQueueDetail) *DescribeJobQueuesOutput
SetJobQueues sets the JobQueues field's value.
func (*DescribeJobQueuesOutput) SetNextToken ¶
func (s *DescribeJobQueuesOutput) SetNextToken(v string) *DescribeJobQueuesOutput
SetNextToken sets the NextToken field's value.
func (DescribeJobQueuesOutput) String ¶
func (s DescribeJobQueuesOutput) String() string
String returns the string representation
type DescribeJobsInput ¶
type DescribeJobsInput struct { // A space-separated list of up to 100 job IDs. // // Jobs is a required field Jobs []*string `locationName:"jobs" type:"list" required:"true"` // contains filtered or unexported fields }
func (DescribeJobsInput) GoString ¶
func (s DescribeJobsInput) GoString() string
GoString returns the string representation
func (*DescribeJobsInput) SetJobs ¶
func (s *DescribeJobsInput) SetJobs(v []*string) *DescribeJobsInput
SetJobs sets the Jobs field's value.
func (DescribeJobsInput) String ¶
func (s DescribeJobsInput) String() string
String returns the string representation
func (*DescribeJobsInput) Validate ¶
func (s *DescribeJobsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeJobsOutput ¶
type DescribeJobsOutput struct { // The list of jobs. Jobs []*JobDetail `locationName:"jobs" type:"list"` // contains filtered or unexported fields }
func (DescribeJobsOutput) GoString ¶
func (s DescribeJobsOutput) GoString() string
GoString returns the string representation
func (*DescribeJobsOutput) SetJobs ¶
func (s *DescribeJobsOutput) SetJobs(v []*JobDetail) *DescribeJobsOutput
SetJobs sets the Jobs field's value.
func (DescribeJobsOutput) String ¶
func (s DescribeJobsOutput) String() string
String returns the string representation
type Host ¶
type Host struct { // The path on the host container instance that is presented to the container. // If this parameter is empty, then the Docker daemon has assigned a host path // for you. If the host parameter contains a sourcePath file location, then // the data volume persists at the specified location on the host container // instance until you delete it manually. If the sourcePath value does not exist // on the host container instance, the Docker daemon creates it. If the location // does exist, the contents of the source path folder are exported. SourcePath *string `locationName:"sourcePath" type:"string"` // contains filtered or unexported fields }
The contents of the host parameter determine whether your data volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume, but the data is not guaranteed to persist after the containers associated with it stop running.
func (*Host) SetSourcePath ¶
SetSourcePath sets the SourcePath field's value.
type JobDefinition ¶
type JobDefinition struct { // An object with various properties specific to container-based jobs. ContainerProperties *ContainerProperties `locationName:"containerProperties" type:"structure"` // The Amazon Resource Name (ARN) for the job definition. // // JobDefinitionArn is a required field JobDefinitionArn *string `locationName:"jobDefinitionArn" type:"string" required:"true"` // The name of the job definition. // // JobDefinitionName is a required field JobDefinitionName *string `locationName:"jobDefinitionName" type:"string" required:"true"` // Default parameters or parameter substitution placeholders that are set in // the job definition. Parameters are specified as a key-value pair mapping. // Parameters in a SubmitJob request override any corresponding parameter defaults // from the job definition. Parameters map[string]*string `locationName:"parameters" type:"map"` // The retry strategy to use for failed jobs that are submitted with this job // definition. RetryStrategy *RetryStrategy `locationName:"retryStrategy" type:"structure"` // The revision of the job definition. // // Revision is a required field Revision *int64 `locationName:"revision" type:"integer" required:"true"` // The status of the job definition. Status *string `locationName:"status" type:"string"` // The timeout configuration for jobs that are submitted with this job definition. // You can specify a timeout duration after which AWS Batch terminates your // jobs if they have not finished. Timeout *JobTimeout `locationName:"timeout" type:"structure"` // The type of job definition. // // Type is a required field Type *string `locationName:"type" type:"string" required:"true"` // contains filtered or unexported fields }
An object representing an AWS Batch job definition.
func (JobDefinition) GoString ¶
func (s JobDefinition) GoString() string
GoString returns the string representation
func (*JobDefinition) SetContainerProperties ¶
func (s *JobDefinition) SetContainerProperties(v *ContainerProperties) *JobDefinition
SetContainerProperties sets the ContainerProperties field's value.
func (*JobDefinition) SetJobDefinitionArn ¶
func (s *JobDefinition) SetJobDefinitionArn(v string) *JobDefinition
SetJobDefinitionArn sets the JobDefinitionArn field's value.
func (*JobDefinition) SetJobDefinitionName ¶
func (s *JobDefinition) SetJobDefinitionName(v string) *JobDefinition
SetJobDefinitionName sets the JobDefinitionName field's value.
func (*JobDefinition) SetParameters ¶
func (s *JobDefinition) SetParameters(v map[string]*string) *JobDefinition
SetParameters sets the Parameters field's value.
func (*JobDefinition) SetRetryStrategy ¶ added in v1.8.5
func (s *JobDefinition) SetRetryStrategy(v *RetryStrategy) *JobDefinition
SetRetryStrategy sets the RetryStrategy field's value.
func (*JobDefinition) SetRevision ¶
func (s *JobDefinition) SetRevision(v int64) *JobDefinition
SetRevision sets the Revision field's value.
func (*JobDefinition) SetStatus ¶
func (s *JobDefinition) SetStatus(v string) *JobDefinition
SetStatus sets the Status field's value.
func (*JobDefinition) SetTimeout ¶ added in v1.13.30
func (s *JobDefinition) SetTimeout(v *JobTimeout) *JobDefinition
SetTimeout sets the Timeout field's value.
func (*JobDefinition) SetType ¶
func (s *JobDefinition) SetType(v string) *JobDefinition
SetType sets the Type field's value.
func (JobDefinition) String ¶
func (s JobDefinition) String() string
String returns the string representation
type JobDependency ¶
type JobDependency struct { // The job ID of the AWS Batch job associated with this dependency. JobId *string `locationName:"jobId" type:"string"` // The type of the job dependency. Type *string `locationName:"type" type:"string" enum:"ArrayJobDependency"` // contains filtered or unexported fields }
An object representing an AWS Batch job dependency.
func (JobDependency) GoString ¶
func (s JobDependency) GoString() string
GoString returns the string representation
func (*JobDependency) SetJobId ¶
func (s *JobDependency) SetJobId(v string) *JobDependency
SetJobId sets the JobId field's value.
func (*JobDependency) SetType ¶ added in v1.12.35
func (s *JobDependency) SetType(v string) *JobDependency
SetType sets the Type field's value.
func (JobDependency) String ¶
func (s JobDependency) String() string
String returns the string representation
type JobDetail ¶
type JobDetail struct { // The array properties of the job, if it is an array job. ArrayProperties *ArrayPropertiesDetail `locationName:"arrayProperties" type:"structure"` // A list of job attempts associated with this job. Attempts []*AttemptDetail `locationName:"attempts" type:"list"` // An object representing the details of the container that is associated with // the job. Container *ContainerDetail `locationName:"container" type:"structure"` // The Unix time stamp (in seconds and milliseconds) for when the job was created. // For non-array jobs and parent array jobs, this is when the job entered the // SUBMITTED state (at the time SubmitJob was called). For array child jobs, // this is when the child job was spawned by its parent and entered the PENDING // state. CreatedAt *int64 `locationName:"createdAt" type:"long"` // A list of job names or IDs on which this job depends. DependsOn []*JobDependency `locationName:"dependsOn" type:"list"` // The job definition that is used by this job. // // JobDefinition is a required field JobDefinition *string `locationName:"jobDefinition" type:"string" required:"true"` // The ID for the job. // // JobId is a required field JobId *string `locationName:"jobId" type:"string" required:"true"` // The name of the job. // // JobName is a required field JobName *string `locationName:"jobName" type:"string" required:"true"` // The Amazon Resource Name (ARN) of the job queue with which the job is associated. // // JobQueue is a required field JobQueue *string `locationName:"jobQueue" type:"string" required:"true"` // Additional parameters passed to the job that replace parameter substitution // placeholders or override any corresponding parameter defaults from the job // definition. Parameters map[string]*string `locationName:"parameters" type:"map"` // The retry strategy to use for this job if an attempt fails. RetryStrategy *RetryStrategy `locationName:"retryStrategy" type:"structure"` // The Unix time stamp (in seconds and milliseconds) for when the job was started // (when the job transitioned from the STARTING state to the RUNNING state). // // StartedAt is a required field StartedAt *int64 `locationName:"startedAt" type:"long" required:"true"` // The current status for the job. // // Status is a required field Status *string `locationName:"status" type:"string" required:"true" enum:"JobStatus"` // A short, human-readable string to provide additional details about the current // status of the job. StatusReason *string `locationName:"statusReason" type:"string"` // The Unix time stamp (in seconds and milliseconds) for when the job was stopped // (when the job transitioned from the RUNNING state to a terminal state, such // as SUCCEEDED or FAILED). StoppedAt *int64 `locationName:"stoppedAt" type:"long"` // The timeout configuration for the job. Timeout *JobTimeout `locationName:"timeout" type:"structure"` // contains filtered or unexported fields }
An object representing an AWS Batch job.
func (*JobDetail) SetArrayProperties ¶ added in v1.12.35
func (s *JobDetail) SetArrayProperties(v *ArrayPropertiesDetail) *JobDetail
SetArrayProperties sets the ArrayProperties field's value.
func (*JobDetail) SetAttempts ¶ added in v1.8.5
func (s *JobDetail) SetAttempts(v []*AttemptDetail) *JobDetail
SetAttempts sets the Attempts field's value.
func (*JobDetail) SetContainer ¶
func (s *JobDetail) SetContainer(v *ContainerDetail) *JobDetail
SetContainer sets the Container field's value.
func (*JobDetail) SetCreatedAt ¶
SetCreatedAt sets the CreatedAt field's value.
func (*JobDetail) SetDependsOn ¶
func (s *JobDetail) SetDependsOn(v []*JobDependency) *JobDetail
SetDependsOn sets the DependsOn field's value.
func (*JobDetail) SetJobDefinition ¶
SetJobDefinition sets the JobDefinition field's value.
func (*JobDetail) SetJobName ¶
SetJobName sets the JobName field's value.
func (*JobDetail) SetJobQueue ¶
SetJobQueue sets the JobQueue field's value.
func (*JobDetail) SetParameters ¶
SetParameters sets the Parameters field's value.
func (*JobDetail) SetRetryStrategy ¶ added in v1.8.5
func (s *JobDetail) SetRetryStrategy(v *RetryStrategy) *JobDetail
SetRetryStrategy sets the RetryStrategy field's value.
func (*JobDetail) SetStartedAt ¶
SetStartedAt sets the StartedAt field's value.
func (*JobDetail) SetStatusReason ¶
SetStatusReason sets the StatusReason field's value.
func (*JobDetail) SetStoppedAt ¶
SetStoppedAt sets the StoppedAt field's value.
func (*JobDetail) SetTimeout ¶ added in v1.13.30
func (s *JobDetail) SetTimeout(v *JobTimeout) *JobDetail
SetTimeout sets the Timeout field's value.
type JobQueueDetail ¶
type JobQueueDetail struct { // The compute environments that are attached to the job queue and the order // in which job placement is preferred. Compute environments are selected for // job placement in ascending order. // // ComputeEnvironmentOrder is a required field ComputeEnvironmentOrder []*ComputeEnvironmentOrder `locationName:"computeEnvironmentOrder" type:"list" required:"true"` // The Amazon Resource Name (ARN) of the job queue. // // JobQueueArn is a required field JobQueueArn *string `locationName:"jobQueueArn" type:"string" required:"true"` // The name of the job queue. // // JobQueueName is a required field JobQueueName *string `locationName:"jobQueueName" type:"string" required:"true"` // The priority of the job queue. // // Priority is a required field Priority *int64 `locationName:"priority" type:"integer" required:"true"` // Describes the ability of the queue to accept new jobs. // // State is a required field State *string `locationName:"state" type:"string" required:"true" enum:"JQState"` // The status of the job queue (for example, CREATING or VALID). Status *string `locationName:"status" type:"string" enum:"JQStatus"` // A short, human-readable string to provide additional details about the current // status of the job queue. StatusReason *string `locationName:"statusReason" type:"string"` // contains filtered or unexported fields }
An object representing the details of an AWS Batch job queue.
func (JobQueueDetail) GoString ¶
func (s JobQueueDetail) GoString() string
GoString returns the string representation
func (*JobQueueDetail) SetComputeEnvironmentOrder ¶
func (s *JobQueueDetail) SetComputeEnvironmentOrder(v []*ComputeEnvironmentOrder) *JobQueueDetail
SetComputeEnvironmentOrder sets the ComputeEnvironmentOrder field's value.
func (*JobQueueDetail) SetJobQueueArn ¶
func (s *JobQueueDetail) SetJobQueueArn(v string) *JobQueueDetail
SetJobQueueArn sets the JobQueueArn field's value.
func (*JobQueueDetail) SetJobQueueName ¶
func (s *JobQueueDetail) SetJobQueueName(v string) *JobQueueDetail
SetJobQueueName sets the JobQueueName field's value.
func (*JobQueueDetail) SetPriority ¶
func (s *JobQueueDetail) SetPriority(v int64) *JobQueueDetail
SetPriority sets the Priority field's value.
func (*JobQueueDetail) SetState ¶
func (s *JobQueueDetail) SetState(v string) *JobQueueDetail
SetState sets the State field's value.
func (*JobQueueDetail) SetStatus ¶
func (s *JobQueueDetail) SetStatus(v string) *JobQueueDetail
SetStatus sets the Status field's value.
func (*JobQueueDetail) SetStatusReason ¶
func (s *JobQueueDetail) SetStatusReason(v string) *JobQueueDetail
SetStatusReason sets the StatusReason field's value.
func (JobQueueDetail) String ¶
func (s JobQueueDetail) String() string
String returns the string representation
type JobSummary ¶
type JobSummary struct { // The array properties of the job, if it is an array job. ArrayProperties *ArrayPropertiesSummary `locationName:"arrayProperties" type:"structure"` // An object representing the details of the container that is associated with // the job. Container *ContainerSummary `locationName:"container" type:"structure"` // The Unix time stamp for when the job was created. For non-array jobs and // parent array jobs, this is when the job entered the SUBMITTED state (at the // time SubmitJob was called). For array child jobs, this is when the child // job was spawned by its parent and entered the PENDING state. CreatedAt *int64 `locationName:"createdAt" type:"long"` // The ID of the job. // // JobId is a required field JobId *string `locationName:"jobId" type:"string" required:"true"` // The name of the job. // // JobName is a required field JobName *string `locationName:"jobName" type:"string" required:"true"` // The Unix time stamp for when the job was started (when the job transitioned // from the STARTING state to the RUNNING state). StartedAt *int64 `locationName:"startedAt" type:"long"` // The current status for the job. Status *string `locationName:"status" type:"string" enum:"JobStatus"` // A short, human-readable string to provide additional details about the current // status of the job. StatusReason *string `locationName:"statusReason" type:"string"` // The Unix time stamp for when the job was stopped (when the job transitioned // from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED). StoppedAt *int64 `locationName:"stoppedAt" type:"long"` // contains filtered or unexported fields }
An object representing summary details of a job.
func (JobSummary) GoString ¶
func (s JobSummary) GoString() string
GoString returns the string representation
func (*JobSummary) SetArrayProperties ¶ added in v1.12.35
func (s *JobSummary) SetArrayProperties(v *ArrayPropertiesSummary) *JobSummary
SetArrayProperties sets the ArrayProperties field's value.
func (*JobSummary) SetContainer ¶ added in v1.12.35
func (s *JobSummary) SetContainer(v *ContainerSummary) *JobSummary
SetContainer sets the Container field's value.
func (*JobSummary) SetCreatedAt ¶ added in v1.12.35
func (s *JobSummary) SetCreatedAt(v int64) *JobSummary
SetCreatedAt sets the CreatedAt field's value.
func (*JobSummary) SetJobId ¶
func (s *JobSummary) SetJobId(v string) *JobSummary
SetJobId sets the JobId field's value.
func (*JobSummary) SetJobName ¶
func (s *JobSummary) SetJobName(v string) *JobSummary
SetJobName sets the JobName field's value.
func (*JobSummary) SetStartedAt ¶ added in v1.12.35
func (s *JobSummary) SetStartedAt(v int64) *JobSummary
SetStartedAt sets the StartedAt field's value.
func (*JobSummary) SetStatus ¶ added in v1.12.35
func (s *JobSummary) SetStatus(v string) *JobSummary
SetStatus sets the Status field's value.
func (*JobSummary) SetStatusReason ¶ added in v1.12.35
func (s *JobSummary) SetStatusReason(v string) *JobSummary
SetStatusReason sets the StatusReason field's value.
func (*JobSummary) SetStoppedAt ¶ added in v1.12.35
func (s *JobSummary) SetStoppedAt(v int64) *JobSummary
SetStoppedAt sets the StoppedAt field's value.
func (JobSummary) String ¶
func (s JobSummary) String() string
String returns the string representation
type JobTimeout ¶ added in v1.13.30
type JobTimeout struct { // The time duration in seconds (measured from the job attempt's startedAt timestamp) // after which AWS Batch terminates your jobs if they have not finished. AttemptDurationSeconds *int64 `locationName:"attemptDurationSeconds" type:"integer"` // contains filtered or unexported fields }
An object representing a job timeout configuration.
func (JobTimeout) GoString ¶ added in v1.13.30
func (s JobTimeout) GoString() string
GoString returns the string representation
func (*JobTimeout) SetAttemptDurationSeconds ¶ added in v1.13.30
func (s *JobTimeout) SetAttemptDurationSeconds(v int64) *JobTimeout
SetAttemptDurationSeconds sets the AttemptDurationSeconds field's value.
func (JobTimeout) String ¶ added in v1.13.30
func (s JobTimeout) String() string
String returns the string representation
type KeyValuePair ¶
type KeyValuePair struct { // The name of the key-value pair. For environment variables, this is the name // of the environment variable. Name *string `locationName:"name" type:"string"` // The value of the key-value pair. For environment variables, this is the value // of the environment variable. Value *string `locationName:"value" type:"string"` // contains filtered or unexported fields }
A key-value pair object.
func (KeyValuePair) GoString ¶
func (s KeyValuePair) GoString() string
GoString returns the string representation
func (*KeyValuePair) SetName ¶
func (s *KeyValuePair) SetName(v string) *KeyValuePair
SetName sets the Name field's value.
func (*KeyValuePair) SetValue ¶
func (s *KeyValuePair) SetValue(v string) *KeyValuePair
SetValue sets the Value field's value.
func (KeyValuePair) String ¶
func (s KeyValuePair) String() string
String returns the string representation
type ListJobsInput ¶
type ListJobsInput struct { // The job ID for an array job. Specifying an array job ID with this parameter // lists all child jobs from within the specified array. ArrayJobId *string `locationName:"arrayJobId" type:"string"` // The name or full Amazon Resource Name (ARN) of the job queue with which to // list jobs. JobQueue *string `locationName:"jobQueue" type:"string"` // The job status with which to filter jobs in the specified queue. If you do // not specify a status, only RUNNING jobs are returned. JobStatus *string `locationName:"jobStatus" type:"string" enum:"JobStatus"` // The maximum number of results returned by ListJobs in paginated output. When // this parameter is used, ListJobs only returns maxResults results in a single // page along with a nextToken response element. The remaining results of the // initial request can be seen by sending another ListJobs request with the // returned nextToken value. This value can be between 1 and 100. If this parameter // is not used, then ListJobs returns up to 100 results and a nextToken value // if applicable. MaxResults *int64 `locationName:"maxResults" type:"integer"` // The nextToken value returned from a previous paginated ListJobs request where // maxResults was used and the results exceeded the value of that parameter. // Pagination continues from the end of the previous results that returned the // nextToken value. This value is null when there are no more results to return. // // This token should be treated as an opaque identifier that is only used to // retrieve the next items in a list and not for other programmatic purposes. NextToken *string `locationName:"nextToken" type:"string"` // contains filtered or unexported fields }
func (ListJobsInput) GoString ¶
func (s ListJobsInput) GoString() string
GoString returns the string representation
func (*ListJobsInput) SetArrayJobId ¶ added in v1.12.35
func (s *ListJobsInput) SetArrayJobId(v string) *ListJobsInput
SetArrayJobId sets the ArrayJobId field's value.
func (*ListJobsInput) SetJobQueue ¶
func (s *ListJobsInput) SetJobQueue(v string) *ListJobsInput
SetJobQueue sets the JobQueue field's value.
func (*ListJobsInput) SetJobStatus ¶
func (s *ListJobsInput) SetJobStatus(v string) *ListJobsInput
SetJobStatus sets the JobStatus field's value.
func (*ListJobsInput) SetMaxResults ¶
func (s *ListJobsInput) SetMaxResults(v int64) *ListJobsInput
SetMaxResults sets the MaxResults field's value.
func (*ListJobsInput) SetNextToken ¶
func (s *ListJobsInput) SetNextToken(v string) *ListJobsInput
SetNextToken sets the NextToken field's value.
func (ListJobsInput) String ¶
func (s ListJobsInput) String() string
String returns the string representation
type ListJobsOutput ¶
type ListJobsOutput struct { // A list of job summaries that match the request. // // JobSummaryList is a required field JobSummaryList []*JobSummary `locationName:"jobSummaryList" type:"list" required:"true"` // The nextToken value to include in a future ListJobs request. When the results // of a ListJobs request exceed maxResults, this value can be used to retrieve // the next page of results. This value is null when there are no more results // to return. NextToken *string `locationName:"nextToken" type:"string"` // contains filtered or unexported fields }
func (ListJobsOutput) GoString ¶
func (s ListJobsOutput) GoString() string
GoString returns the string representation
func (*ListJobsOutput) SetJobSummaryList ¶
func (s *ListJobsOutput) SetJobSummaryList(v []*JobSummary) *ListJobsOutput
SetJobSummaryList sets the JobSummaryList field's value.
func (*ListJobsOutput) SetNextToken ¶
func (s *ListJobsOutput) SetNextToken(v string) *ListJobsOutput
SetNextToken sets the NextToken field's value.
func (ListJobsOutput) String ¶
func (s ListJobsOutput) String() string
String returns the string representation
type MountPoint ¶
type MountPoint struct { // The path on the container at which to mount the host volume. ContainerPath *string `locationName:"containerPath" type:"string"` // If this value is true, the container has read-only access to the volume; // otherwise, the container can write to the volume. The default value is false. ReadOnly *bool `locationName:"readOnly" type:"boolean"` // The name of the volume to mount. SourceVolume *string `locationName:"sourceVolume" type:"string"` // contains filtered or unexported fields }
Details on a Docker volume mount point that is used in a job's container properties.
func (MountPoint) GoString ¶
func (s MountPoint) GoString() string
GoString returns the string representation
func (*MountPoint) SetContainerPath ¶
func (s *MountPoint) SetContainerPath(v string) *MountPoint
SetContainerPath sets the ContainerPath field's value.
func (*MountPoint) SetReadOnly ¶
func (s *MountPoint) SetReadOnly(v bool) *MountPoint
SetReadOnly sets the ReadOnly field's value.
func (*MountPoint) SetSourceVolume ¶
func (s *MountPoint) SetSourceVolume(v string) *MountPoint
SetSourceVolume sets the SourceVolume field's value.
func (MountPoint) String ¶
func (s MountPoint) String() string
String returns the string representation
type RegisterJobDefinitionInput ¶
type RegisterJobDefinitionInput struct { // An object with various properties specific for container-based jobs. This // parameter is required if the type parameter is container. ContainerProperties *ContainerProperties `locationName:"containerProperties" type:"structure"` // The name of the job definition to register. Up to 128 letters (uppercase // and lowercase), numbers, hyphens, and underscores are allowed. // // JobDefinitionName is a required field JobDefinitionName *string `locationName:"jobDefinitionName" type:"string" required:"true"` // Default parameter substitution placeholders to set in the job definition. // Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob // request override any corresponding parameter defaults from the job definition. Parameters map[string]*string `locationName:"parameters" type:"map"` // The retry strategy to use for failed jobs that are submitted with this job // definition. Any retry strategy that is specified during a SubmitJob operation // overrides the retry strategy defined here. If a job is terminated due to // a timeout, it is not retried. RetryStrategy *RetryStrategy `locationName:"retryStrategy" type:"structure"` // The timeout configuration for jobs that are submitted with this job definition, // after which AWS Batch terminates your jobs if they have not finished. If // a job is terminated due to a timeout, it is not retried. The minimum value // for the timeout is 60 seconds. Any timeout configuration that is specified // during a SubmitJob operation overrides the timeout configuration defined // here. For more information, see Job Timeouts (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/job_timeouts.html) // in the Amazon Elastic Container Service Developer Guide. Timeout *JobTimeout `locationName:"timeout" type:"structure"` // The type of job definition. // // Type is a required field Type *string `locationName:"type" type:"string" required:"true" enum:"JobDefinitionType"` // contains filtered or unexported fields }
func (RegisterJobDefinitionInput) GoString ¶
func (s RegisterJobDefinitionInput) GoString() string
GoString returns the string representation
func (*RegisterJobDefinitionInput) SetContainerProperties ¶
func (s *RegisterJobDefinitionInput) SetContainerProperties(v *ContainerProperties) *RegisterJobDefinitionInput
SetContainerProperties sets the ContainerProperties field's value.
func (*RegisterJobDefinitionInput) SetJobDefinitionName ¶
func (s *RegisterJobDefinitionInput) SetJobDefinitionName(v string) *RegisterJobDefinitionInput
SetJobDefinitionName sets the JobDefinitionName field's value.
func (*RegisterJobDefinitionInput) SetParameters ¶
func (s *RegisterJobDefinitionInput) SetParameters(v map[string]*string) *RegisterJobDefinitionInput
SetParameters sets the Parameters field's value.
func (*RegisterJobDefinitionInput) SetRetryStrategy ¶ added in v1.8.5
func (s *RegisterJobDefinitionInput) SetRetryStrategy(v *RetryStrategy) *RegisterJobDefinitionInput
SetRetryStrategy sets the RetryStrategy field's value.
func (*RegisterJobDefinitionInput) SetTimeout ¶ added in v1.13.30
func (s *RegisterJobDefinitionInput) SetTimeout(v *JobTimeout) *RegisterJobDefinitionInput
SetTimeout sets the Timeout field's value.
func (*RegisterJobDefinitionInput) SetType ¶
func (s *RegisterJobDefinitionInput) SetType(v string) *RegisterJobDefinitionInput
SetType sets the Type field's value.
func (RegisterJobDefinitionInput) String ¶
func (s RegisterJobDefinitionInput) String() string
String returns the string representation
func (*RegisterJobDefinitionInput) Validate ¶
func (s *RegisterJobDefinitionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type RegisterJobDefinitionOutput ¶
type RegisterJobDefinitionOutput struct { // The Amazon Resource Name (ARN) of the job definition. // // JobDefinitionArn is a required field JobDefinitionArn *string `locationName:"jobDefinitionArn" type:"string" required:"true"` // The name of the job definition. // // JobDefinitionName is a required field JobDefinitionName *string `locationName:"jobDefinitionName" type:"string" required:"true"` // The revision of the job definition. // // Revision is a required field Revision *int64 `locationName:"revision" type:"integer" required:"true"` // contains filtered or unexported fields }
func (RegisterJobDefinitionOutput) GoString ¶
func (s RegisterJobDefinitionOutput) GoString() string
GoString returns the string representation
func (*RegisterJobDefinitionOutput) SetJobDefinitionArn ¶
func (s *RegisterJobDefinitionOutput) SetJobDefinitionArn(v string) *RegisterJobDefinitionOutput
SetJobDefinitionArn sets the JobDefinitionArn field's value.
func (*RegisterJobDefinitionOutput) SetJobDefinitionName ¶
func (s *RegisterJobDefinitionOutput) SetJobDefinitionName(v string) *RegisterJobDefinitionOutput
SetJobDefinitionName sets the JobDefinitionName field's value.
func (*RegisterJobDefinitionOutput) SetRevision ¶
func (s *RegisterJobDefinitionOutput) SetRevision(v int64) *RegisterJobDefinitionOutput
SetRevision sets the Revision field's value.
func (RegisterJobDefinitionOutput) String ¶
func (s RegisterJobDefinitionOutput) String() string
String returns the string representation
type RetryStrategy ¶ added in v1.8.5
type RetryStrategy struct { // The number of times to move a job to the RUNNABLE status. You may specify // between 1 and 10 attempts. If the value of attempts is greater than one, // the job is retried if it fails until it has moved to RUNNABLE that many times. Attempts *int64 `locationName:"attempts" type:"integer"` // contains filtered or unexported fields }
The retry strategy associated with a job.
func (RetryStrategy) GoString ¶ added in v1.8.5
func (s RetryStrategy) GoString() string
GoString returns the string representation
func (*RetryStrategy) SetAttempts ¶ added in v1.8.5
func (s *RetryStrategy) SetAttempts(v int64) *RetryStrategy
SetAttempts sets the Attempts field's value.
func (RetryStrategy) String ¶ added in v1.8.5
func (s RetryStrategy) String() string
String returns the string representation
type SubmitJobInput ¶
type SubmitJobInput struct { // The array properties for the submitted job, such as the size of the array. // The array size can be between 2 and 10,000. If you specify array properties // for a job, it becomes an array job. For more information, see Array Jobs // (http://docs.aws.amazon.com/batch/latest/userguide/array_jobs.html) in the // AWS Batch User Guide. ArrayProperties *ArrayProperties `locationName:"arrayProperties" type:"structure"` // A list of container overrides in JSON format that specify the name of a container // in the specified job definition and the overrides it should receive. You // can override the default command for a container (that is specified in the // job definition or the Docker image) with a command override. You can also // override existing environment variables (that are specified in the job definition // or Docker image) on a container or add new environment variables to it with // an environment override. ContainerOverrides *ContainerOverrides `locationName:"containerOverrides" type:"structure"` // A list of dependencies for the job. A job can depend upon a maximum of 20 // jobs. You can specify a SEQUENTIAL type dependency without specifying a job // ID for array jobs so that each child array job completes sequentially, starting // at index 0. You can also specify an N_TO_N type dependency with a job ID // for array jobs so that each index child of this job must wait for the corresponding // index child of each dependency to complete before it can begin. DependsOn []*JobDependency `locationName:"dependsOn" type:"list"` // The job definition used by this job. This value can be either a name:revision // or the Amazon Resource Name (ARN) for the job definition. // // JobDefinition is a required field JobDefinition *string `locationName:"jobDefinition" type:"string" required:"true"` // The name of the job. The first character must be alphanumeric, and up to // 128 letters (uppercase and lowercase), numbers, hyphens, and underscores // are allowed. // // JobName is a required field JobName *string `locationName:"jobName" type:"string" required:"true"` // The job queue into which the job is submitted. You can specify either the // name or the Amazon Resource Name (ARN) of the queue. // // JobQueue is a required field JobQueue *string `locationName:"jobQueue" type:"string" required:"true"` // Additional parameters passed to the job that replace parameter substitution // placeholders that are set in the job definition. Parameters are specified // as a key and value pair mapping. Parameters in a SubmitJob request override // any corresponding parameter defaults from the job definition. Parameters map[string]*string `locationName:"parameters" type:"map"` // The retry strategy to use for failed jobs from this SubmitJob operation. // When a retry strategy is specified here, it overrides the retry strategy // defined in the job definition. RetryStrategy *RetryStrategy `locationName:"retryStrategy" type:"structure"` // The timeout configuration for this SubmitJob operation. You can specify a // timeout duration after which AWS Batch terminates your jobs if they have // not finished. If a job is terminated due to a timeout, it is not retried. // The minimum value for the timeout is 60 seconds. This configuration overrides // any timeout configuration specified in the job definition. For array jobs, // child jobs have the same timeout configuration as the parent job. For more // information, see Job Timeouts (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/job_timeouts.html) // in the Amazon Elastic Container Service Developer Guide. Timeout *JobTimeout `locationName:"timeout" type:"structure"` // contains filtered or unexported fields }
func (SubmitJobInput) GoString ¶
func (s SubmitJobInput) GoString() string
GoString returns the string representation
func (*SubmitJobInput) SetArrayProperties ¶ added in v1.12.35
func (s *SubmitJobInput) SetArrayProperties(v *ArrayProperties) *SubmitJobInput
SetArrayProperties sets the ArrayProperties field's value.
func (*SubmitJobInput) SetContainerOverrides ¶
func (s *SubmitJobInput) SetContainerOverrides(v *ContainerOverrides) *SubmitJobInput
SetContainerOverrides sets the ContainerOverrides field's value.
func (*SubmitJobInput) SetDependsOn ¶
func (s *SubmitJobInput) SetDependsOn(v []*JobDependency) *SubmitJobInput
SetDependsOn sets the DependsOn field's value.
func (*SubmitJobInput) SetJobDefinition ¶
func (s *SubmitJobInput) SetJobDefinition(v string) *SubmitJobInput
SetJobDefinition sets the JobDefinition field's value.
func (*SubmitJobInput) SetJobName ¶
func (s *SubmitJobInput) SetJobName(v string) *SubmitJobInput
SetJobName sets the JobName field's value.
func (*SubmitJobInput) SetJobQueue ¶
func (s *SubmitJobInput) SetJobQueue(v string) *SubmitJobInput
SetJobQueue sets the JobQueue field's value.
func (*SubmitJobInput) SetParameters ¶
func (s *SubmitJobInput) SetParameters(v map[string]*string) *SubmitJobInput
SetParameters sets the Parameters field's value.
func (*SubmitJobInput) SetRetryStrategy ¶ added in v1.8.5
func (s *SubmitJobInput) SetRetryStrategy(v *RetryStrategy) *SubmitJobInput
SetRetryStrategy sets the RetryStrategy field's value.
func (*SubmitJobInput) SetTimeout ¶ added in v1.13.30
func (s *SubmitJobInput) SetTimeout(v *JobTimeout) *SubmitJobInput
SetTimeout sets the Timeout field's value.
func (SubmitJobInput) String ¶
func (s SubmitJobInput) String() string
String returns the string representation
func (*SubmitJobInput) Validate ¶
func (s *SubmitJobInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type SubmitJobOutput ¶
type SubmitJobOutput struct { // The unique identifier for the job. // // JobId is a required field JobId *string `locationName:"jobId" type:"string" required:"true"` // The name of the job. // // JobName is a required field JobName *string `locationName:"jobName" type:"string" required:"true"` // contains filtered or unexported fields }
func (SubmitJobOutput) GoString ¶
func (s SubmitJobOutput) GoString() string
GoString returns the string representation
func (*SubmitJobOutput) SetJobId ¶
func (s *SubmitJobOutput) SetJobId(v string) *SubmitJobOutput
SetJobId sets the JobId field's value.
func (*SubmitJobOutput) SetJobName ¶
func (s *SubmitJobOutput) SetJobName(v string) *SubmitJobOutput
SetJobName sets the JobName field's value.
func (SubmitJobOutput) String ¶
func (s SubmitJobOutput) String() string
String returns the string representation
type TerminateJobInput ¶
type TerminateJobInput struct { // The AWS Batch job ID of the job to terminate. // // JobId is a required field JobId *string `locationName:"jobId" type:"string" required:"true"` // A message to attach to the job that explains the reason for canceling it. // This message is returned by future DescribeJobs operations on the job. This // message is also recorded in the AWS Batch activity logs. // // Reason is a required field Reason *string `locationName:"reason" type:"string" required:"true"` // contains filtered or unexported fields }
func (TerminateJobInput) GoString ¶
func (s TerminateJobInput) GoString() string
GoString returns the string representation
func (*TerminateJobInput) SetJobId ¶
func (s *TerminateJobInput) SetJobId(v string) *TerminateJobInput
SetJobId sets the JobId field's value.
func (*TerminateJobInput) SetReason ¶
func (s *TerminateJobInput) SetReason(v string) *TerminateJobInput
SetReason sets the Reason field's value.
func (TerminateJobInput) String ¶
func (s TerminateJobInput) String() string
String returns the string representation
func (*TerminateJobInput) Validate ¶
func (s *TerminateJobInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type TerminateJobOutput ¶
type TerminateJobOutput struct {
// contains filtered or unexported fields
}
func (TerminateJobOutput) GoString ¶
func (s TerminateJobOutput) GoString() string
GoString returns the string representation
func (TerminateJobOutput) String ¶
func (s TerminateJobOutput) String() string
String returns the string representation
type Ulimit ¶
type Ulimit struct { // The hard limit for the ulimit type. // // HardLimit is a required field HardLimit *int64 `locationName:"hardLimit" type:"integer" required:"true"` // The type of the ulimit. // // Name is a required field Name *string `locationName:"name" type:"string" required:"true"` // The soft limit for the ulimit type. // // SoftLimit is a required field SoftLimit *int64 `locationName:"softLimit" type:"integer" required:"true"` // contains filtered or unexported fields }
The ulimit settings to pass to the container.
func (*Ulimit) SetHardLimit ¶
SetHardLimit sets the HardLimit field's value.
func (*Ulimit) SetSoftLimit ¶
SetSoftLimit sets the SoftLimit field's value.
type UpdateComputeEnvironmentInput ¶
type UpdateComputeEnvironmentInput struct { // The name or full Amazon Resource Name (ARN) of the compute environment to // update. // // ComputeEnvironment is a required field ComputeEnvironment *string `locationName:"computeEnvironment" type:"string" required:"true"` // Details of the compute resources managed by the compute environment. Required // for a managed compute environment. ComputeResources *ComputeResourceUpdate `locationName:"computeResources" type:"structure"` // The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch // to make calls to other AWS services on your behalf. // // If your specified role has a path other than /, then you must either specify // the full role ARN (this is recommended) or prefix the role name with the // path. // // Depending on how you created your AWS Batch service role, its ARN may contain // the service-role path prefix. When you only specify the name of the service // role, AWS Batch assumes that your ARN does not use the service-role path // prefix. Because of this, we recommend that you specify the full ARN of your // service role when you create compute environments. ServiceRole *string `locationName:"serviceRole" type:"string"` // The state of the compute environment. Compute environments in the ENABLED // state can accept jobs from a queue and scale in or out automatically based // on the workload demand of its associated queues. State *string `locationName:"state" type:"string" enum:"CEState"` // contains filtered or unexported fields }
func (UpdateComputeEnvironmentInput) GoString ¶
func (s UpdateComputeEnvironmentInput) GoString() string
GoString returns the string representation
func (*UpdateComputeEnvironmentInput) SetComputeEnvironment ¶
func (s *UpdateComputeEnvironmentInput) SetComputeEnvironment(v string) *UpdateComputeEnvironmentInput
SetComputeEnvironment sets the ComputeEnvironment field's value.
func (*UpdateComputeEnvironmentInput) SetComputeResources ¶
func (s *UpdateComputeEnvironmentInput) SetComputeResources(v *ComputeResourceUpdate) *UpdateComputeEnvironmentInput
SetComputeResources sets the ComputeResources field's value.
func (*UpdateComputeEnvironmentInput) SetServiceRole ¶
func (s *UpdateComputeEnvironmentInput) SetServiceRole(v string) *UpdateComputeEnvironmentInput
SetServiceRole sets the ServiceRole field's value.
func (*UpdateComputeEnvironmentInput) SetState ¶
func (s *UpdateComputeEnvironmentInput) SetState(v string) *UpdateComputeEnvironmentInput
SetState sets the State field's value.
func (UpdateComputeEnvironmentInput) String ¶
func (s UpdateComputeEnvironmentInput) String() string
String returns the string representation
func (*UpdateComputeEnvironmentInput) Validate ¶
func (s *UpdateComputeEnvironmentInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateComputeEnvironmentOutput ¶
type UpdateComputeEnvironmentOutput struct { // The Amazon Resource Name (ARN) of the compute environment. ComputeEnvironmentArn *string `locationName:"computeEnvironmentArn" type:"string"` // The name of compute environment. ComputeEnvironmentName *string `locationName:"computeEnvironmentName" type:"string"` // contains filtered or unexported fields }
func (UpdateComputeEnvironmentOutput) GoString ¶
func (s UpdateComputeEnvironmentOutput) GoString() string
GoString returns the string representation
func (*UpdateComputeEnvironmentOutput) SetComputeEnvironmentArn ¶
func (s *UpdateComputeEnvironmentOutput) SetComputeEnvironmentArn(v string) *UpdateComputeEnvironmentOutput
SetComputeEnvironmentArn sets the ComputeEnvironmentArn field's value.
func (*UpdateComputeEnvironmentOutput) SetComputeEnvironmentName ¶
func (s *UpdateComputeEnvironmentOutput) SetComputeEnvironmentName(v string) *UpdateComputeEnvironmentOutput
SetComputeEnvironmentName sets the ComputeEnvironmentName field's value.
func (UpdateComputeEnvironmentOutput) String ¶
func (s UpdateComputeEnvironmentOutput) String() string
String returns the string representation
type UpdateJobQueueInput ¶
type UpdateJobQueueInput struct { // Details the set of compute environments mapped to a job queue and their order // relative to each other. This is one of the parameters used by the job scheduler // to determine which compute environment should execute a given job. ComputeEnvironmentOrder []*ComputeEnvironmentOrder `locationName:"computeEnvironmentOrder" type:"list"` // The name or the Amazon Resource Name (ARN) of the job queue. // // JobQueue is a required field JobQueue *string `locationName:"jobQueue" type:"string" required:"true"` // The priority of the job queue. Job queues with a higher priority (or a higher // integer value for the priority parameter) are evaluated first when associated // with same compute environment. Priority is determined in descending order, // for example, a job queue with a priority value of 10 is given scheduling // preference over a job queue with a priority value of 1. Priority *int64 `locationName:"priority" type:"integer"` // Describes the queue's ability to accept new jobs. State *string `locationName:"state" type:"string" enum:"JQState"` // contains filtered or unexported fields }
func (UpdateJobQueueInput) GoString ¶
func (s UpdateJobQueueInput) GoString() string
GoString returns the string representation
func (*UpdateJobQueueInput) SetComputeEnvironmentOrder ¶
func (s *UpdateJobQueueInput) SetComputeEnvironmentOrder(v []*ComputeEnvironmentOrder) *UpdateJobQueueInput
SetComputeEnvironmentOrder sets the ComputeEnvironmentOrder field's value.
func (*UpdateJobQueueInput) SetJobQueue ¶
func (s *UpdateJobQueueInput) SetJobQueue(v string) *UpdateJobQueueInput
SetJobQueue sets the JobQueue field's value.
func (*UpdateJobQueueInput) SetPriority ¶
func (s *UpdateJobQueueInput) SetPriority(v int64) *UpdateJobQueueInput
SetPriority sets the Priority field's value.
func (*UpdateJobQueueInput) SetState ¶
func (s *UpdateJobQueueInput) SetState(v string) *UpdateJobQueueInput
SetState sets the State field's value.
func (UpdateJobQueueInput) String ¶
func (s UpdateJobQueueInput) String() string
String returns the string representation
func (*UpdateJobQueueInput) Validate ¶
func (s *UpdateJobQueueInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateJobQueueOutput ¶
type UpdateJobQueueOutput struct { // The Amazon Resource Name (ARN) of the job queue. JobQueueArn *string `locationName:"jobQueueArn" type:"string"` // The name of the job queue. JobQueueName *string `locationName:"jobQueueName" type:"string"` // contains filtered or unexported fields }
func (UpdateJobQueueOutput) GoString ¶
func (s UpdateJobQueueOutput) GoString() string
GoString returns the string representation
func (*UpdateJobQueueOutput) SetJobQueueArn ¶
func (s *UpdateJobQueueOutput) SetJobQueueArn(v string) *UpdateJobQueueOutput
SetJobQueueArn sets the JobQueueArn field's value.
func (*UpdateJobQueueOutput) SetJobQueueName ¶
func (s *UpdateJobQueueOutput) SetJobQueueName(v string) *UpdateJobQueueOutput
SetJobQueueName sets the JobQueueName field's value.
func (UpdateJobQueueOutput) String ¶
func (s UpdateJobQueueOutput) String() string
String returns the string representation
type Volume ¶
type Volume struct { // The contents of the host parameter determine whether your data volume persists // on the host container instance and where it is stored. If the host parameter // is empty, then the Docker daemon assigns a host path for your data volume. // However, the data is not guaranteed to persist after the containers associated // with it stop running. Host *Host `locationName:"host" type:"structure"` // The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, // hyphens, and underscores are allowed. This name is referenced in the sourceVolume // parameter of container definition mountPoints. Name *string `locationName:"name" type:"string"` // contains filtered or unexported fields }
A data volume used in a job's container properties.
Directories
¶
Path | Synopsis |
---|---|
Package batchiface provides an interface to enable mocking the AWS Batch service client for testing your code.
|
Package batchiface provides an interface to enable mocking the AWS Batch service client for testing your code. |