aws-sdk-go: github.com/aws/aws-sdk-go/service/batch Index | Examples | Files | Directories

package batch

import "github.com/aws/aws-sdk-go/service/batch"

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

Examples

Package Files

api.go doc.go errors.go service.go

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 (
    // DeviceCgroupPermissionRead is a DeviceCgroupPermission enum value
    DeviceCgroupPermissionRead = "READ"

    // DeviceCgroupPermissionWrite is a DeviceCgroupPermission enum value
    DeviceCgroupPermissionWrite = "WRITE"

    // DeviceCgroupPermissionMknod is a DeviceCgroupPermission enum value
    DeviceCgroupPermissionMknod = "MKNOD"
)
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 (
    // JobDefinitionTypeContainer is a JobDefinitionType enum value
    JobDefinitionTypeContainer = "container"

    // JobDefinitionTypeMultinode is a JobDefinitionType enum value
    JobDefinitionTypeMultinode = "multinode"
)
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"     // Name of service.
    EndpointsID = ServiceName // ID to lookup a service endpoint with.
    ServiceID   = "Batch"     // ServiceID is a unique identifer of a specific service.
)

Service information constants

const (
    // ResourceTypeGpu is a ResourceType enum value
    ResourceTypeGpu = "GPU"
)

type ArrayProperties Uses

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 Uses

func (s ArrayProperties) GoString() string

GoString returns the string representation

func (*ArrayProperties) SetSize Uses

func (s *ArrayProperties) SetSize(v int64) *ArrayProperties

SetSize sets the Size field's value.

func (ArrayProperties) String Uses

func (s ArrayProperties) String() string

String returns the string representation

type ArrayPropertiesDetail Uses

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 Uses

func (s ArrayPropertiesDetail) GoString() string

GoString returns the string representation

func (*ArrayPropertiesDetail) SetIndex Uses

func (s *ArrayPropertiesDetail) SetIndex(v int64) *ArrayPropertiesDetail

SetIndex sets the Index field's value.

func (*ArrayPropertiesDetail) SetSize Uses

func (s *ArrayPropertiesDetail) SetSize(v int64) *ArrayPropertiesDetail

SetSize sets the Size field's value.

func (*ArrayPropertiesDetail) SetStatusSummary Uses

func (s *ArrayPropertiesDetail) SetStatusSummary(v map[string]*int64) *ArrayPropertiesDetail

SetStatusSummary sets the StatusSummary field's value.

func (ArrayPropertiesDetail) String Uses

func (s ArrayPropertiesDetail) String() string

String returns the string representation

type ArrayPropertiesSummary Uses

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 Uses

func (s ArrayPropertiesSummary) GoString() string

GoString returns the string representation

func (*ArrayPropertiesSummary) SetIndex Uses

func (s *ArrayPropertiesSummary) SetIndex(v int64) *ArrayPropertiesSummary

SetIndex sets the Index field's value.

func (*ArrayPropertiesSummary) SetSize Uses

func (s *ArrayPropertiesSummary) SetSize(v int64) *ArrayPropertiesSummary

SetSize sets the Size field's value.

func (ArrayPropertiesSummary) String Uses

func (s ArrayPropertiesSummary) String() string

String returns the string representation

type AttemptContainerDetail Uses

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"`

    // The network interfaces associated with the job attempt.
    NetworkInterfaces []*NetworkInterface `locationName:"networkInterfaces" type:"list"`

    // 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 Uses

func (s AttemptContainerDetail) GoString() string

GoString returns the string representation

func (*AttemptContainerDetail) SetContainerInstanceArn Uses

func (s *AttemptContainerDetail) SetContainerInstanceArn(v string) *AttemptContainerDetail

SetContainerInstanceArn sets the ContainerInstanceArn field's value.

func (*AttemptContainerDetail) SetExitCode Uses

func (s *AttemptContainerDetail) SetExitCode(v int64) *AttemptContainerDetail

SetExitCode sets the ExitCode field's value.

func (*AttemptContainerDetail) SetLogStreamName Uses

func (s *AttemptContainerDetail) SetLogStreamName(v string) *AttemptContainerDetail

SetLogStreamName sets the LogStreamName field's value.

func (*AttemptContainerDetail) SetNetworkInterfaces Uses

func (s *AttemptContainerDetail) SetNetworkInterfaces(v []*NetworkInterface) *AttemptContainerDetail

SetNetworkInterfaces sets the NetworkInterfaces field's value.

func (*AttemptContainerDetail) SetReason Uses

func (s *AttemptContainerDetail) SetReason(v string) *AttemptContainerDetail

SetReason sets the Reason field's value.

func (*AttemptContainerDetail) SetTaskArn Uses

func (s *AttemptContainerDetail) SetTaskArn(v string) *AttemptContainerDetail

SetTaskArn sets the TaskArn field's value.

func (AttemptContainerDetail) String Uses

func (s AttemptContainerDetail) String() string

String returns the string representation

type AttemptDetail Uses

type AttemptDetail struct {

    // Details about the container in this job attempt.
    Container *AttemptContainerDetail `locationName:"container" type:"structure"`

    // The Unix timestamp (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 timestamp (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 Uses

func (s AttemptDetail) GoString() string

GoString returns the string representation

func (*AttemptDetail) SetContainer Uses

func (s *AttemptDetail) SetContainer(v *AttemptContainerDetail) *AttemptDetail

SetContainer sets the Container field's value.

func (*AttemptDetail) SetStartedAt Uses

func (s *AttemptDetail) SetStartedAt(v int64) *AttemptDetail

SetStartedAt sets the StartedAt field's value.

func (*AttemptDetail) SetStatusReason Uses

func (s *AttemptDetail) SetStatusReason(v string) *AttemptDetail

SetStatusReason sets the StatusReason field's value.

func (*AttemptDetail) SetStoppedAt Uses

func (s *AttemptDetail) SetStoppedAt(v int64) *AttemptDetail

SetStoppedAt sets the StoppedAt field's value.

func (AttemptDetail) String Uses

func (s AttemptDetail) String() string

String returns the string representation

type Batch Uses

type Batch struct {
    *client.Client
}

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 Uses

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 Uses

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

To cancel a job

This example cancels a job with the specified job ID.

Code:

svc := batch.New(session.New())
input := &batch.CancelJobInput{
    JobId:  aws.String("1d828f65-7a4d-42e8-996d-3b900ed59dc4"),
    Reason: aws.String("Cancelling job."),
}

result, err := svc.CancelJob(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case batch.ErrCodeClientException:
            fmt.Println(batch.ErrCodeClientException, aerr.Error())
        case batch.ErrCodeServerException:
            fmt.Println(batch.ErrCodeServerException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*Batch) CancelJobRequest Uses

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 successfully.

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 Uses

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 Uses

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 capacity and instance types of the compute resources within the environment. This is based on the compute resource specification that you define or the launch template (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html) that you specify when you create the compute environment. You can choose to use Amazon EC2 On-Demand Instances or Spot Instances in your managed compute environment. You can optionally set a maximum price so that Spot Instances only launch when the Spot Instance price is below a specified percentage of the On-Demand price.

Multi-node parallel jobs are not supported on Spot Instances.

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 (https://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. Then, manually launch your container instances into that Amazon ECS cluster. For more information, see Launching an Amazon ECS Container Instance (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_container_instance.html) in the Amazon Elastic Container Service Developer Guide.

AWS Batch does not upgrade the AMIs in a compute environment after it is created (for example, when a newer version of the Amazon ECS-optimized AMI is available). You are responsible for the management of the guest operating system (including updates and security patches) and any additional application software or utilities that you install on the compute resources. To use a new AMI for your AWS Batch jobs:

Create a new compute environment with the new AMI.

Add the compute environment to an existing job queue.

Remove the old compute environment from your job queue.

Delete the old 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 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

To create a managed EC2 compute environment

This example creates a managed compute environment with specific C4 instance types that are launched on demand. The compute environment is called C4OnDemand.

Code:

svc := batch.New(session.New())
input := &batch.CreateComputeEnvironmentInput{
    ComputeEnvironmentName: aws.String("C4OnDemand"),
    ComputeResources: &batch.ComputeResource{
        DesiredvCpus: aws.Int64(48),
        Ec2KeyPair:   aws.String("id_rsa"),
        InstanceRole: aws.String("ecsInstanceRole"),
        InstanceTypes: []*string{
            aws.String("c4.large"),
            aws.String("c4.xlarge"),
            aws.String("c4.2xlarge"),
            aws.String("c4.4xlarge"),
            aws.String("c4.8xlarge"),
        },
        MaxvCpus: aws.Int64(128),
        MinvCpus: aws.Int64(0),
        SecurityGroupIds: []*string{
            aws.String("sg-cf5093b2"),
        },
        Subnets: []*string{
            aws.String("subnet-220c0e0a"),
            aws.String("subnet-1a95556d"),
            aws.String("subnet-978f6dce"),
        },
        Tags: map[string]*string{
            "Name": aws.String("Batch Instance - C4OnDemand"),
        },
        Type: aws.String("EC2"),
    },
    ServiceRole: aws.String("arn:aws:iam::012345678910:role/AWSBatchServiceRole"),
    State:       aws.String("ENABLED"),
    Type:        aws.String("MANAGED"),
}

result, err := svc.CreateComputeEnvironment(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case batch.ErrCodeClientException:
            fmt.Println(batch.ErrCodeClientException, aerr.Error())
        case batch.ErrCodeServerException:
            fmt.Println(batch.ErrCodeServerException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

To create a managed EC2 Spot compute environment

This example creates a managed compute environment with the M4 instance type that is launched when the Spot bid price is at or below 20% of the On-Demand price for the instance type. The compute environment is called M4Spot.

Code:

svc := batch.New(session.New())
input := &batch.CreateComputeEnvironmentInput{
    ComputeEnvironmentName: aws.String("M4Spot"),
    ComputeResources: &batch.ComputeResource{
        BidPercentage: aws.Int64(20),
        DesiredvCpus:  aws.Int64(4),
        Ec2KeyPair:    aws.String("id_rsa"),
        InstanceRole:  aws.String("ecsInstanceRole"),
        InstanceTypes: []*string{
            aws.String("m4"),
        },
        MaxvCpus: aws.Int64(128),
        MinvCpus: aws.Int64(0),
        SecurityGroupIds: []*string{
            aws.String("sg-cf5093b2"),
        },
        SpotIamFleetRole: aws.String("arn:aws:iam::012345678910:role/aws-ec2-spot-fleet-role"),
        Subnets: []*string{
            aws.String("subnet-220c0e0a"),
            aws.String("subnet-1a95556d"),
            aws.String("subnet-978f6dce"),
        },
        Tags: map[string]*string{
            "Name": aws.String("Batch Instance - M4Spot"),
        },
        Type: aws.String("SPOT"),
    },
    ServiceRole: aws.String("arn:aws:iam::012345678910:role/AWSBatchServiceRole"),
    State:       aws.String("ENABLED"),
    Type:        aws.String("MANAGED"),
}

result, err := svc.CreateComputeEnvironment(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case batch.ErrCodeClientException:
            fmt.Println(batch.ErrCodeClientException, aerr.Error())
        case batch.ErrCodeServerException:
            fmt.Println(batch.ErrCodeServerException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*Batch) CreateComputeEnvironmentRequest Uses

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 successfully.

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 Uses

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 Uses

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

To create a job queue with a single compute environment

This example creates a job queue called LowPriority that uses the M4Spot compute environment.

Code:

svc := batch.New(session.New())
input := &batch.CreateJobQueueInput{
    ComputeEnvironmentOrder: []*batch.ComputeEnvironmentOrder{
        {
            ComputeEnvironment: aws.String("M4Spot"),
            Order:              aws.Int64(1),
        },
    },
    JobQueueName: aws.String("LowPriority"),
    Priority:     aws.Int64(1),
    State:        aws.String("ENABLED"),
}

result, err := svc.CreateJobQueue(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case batch.ErrCodeClientException:
            fmt.Println(batch.ErrCodeClientException, aerr.Error())
        case batch.ErrCodeServerException:
            fmt.Println(batch.ErrCodeServerException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

To create a job queue with multiple compute environments

This example creates a job queue called HighPriority that uses the C4OnDemand compute environment with an order of 1 and the M4Spot compute environment with an order of 2.

Code:

svc := batch.New(session.New())
input := &batch.CreateJobQueueInput{
    ComputeEnvironmentOrder: []*batch.ComputeEnvironmentOrder{
        {
            ComputeEnvironment: aws.String("C4OnDemand"),
            Order:              aws.Int64(1),
        },
        {
            ComputeEnvironment: aws.String("M4Spot"),
            Order:              aws.Int64(2),
        },
    },
    JobQueueName: aws.String("HighPriority"),
    Priority:     aws.Int64(10),
    State:        aws.String("ENABLED"),
}

result, err := svc.CreateJobQueue(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case batch.ErrCodeClientException:
            fmt.Println(batch.ErrCodeClientException, aerr.Error())
        case batch.ErrCodeServerException:
            fmt.Println(batch.ErrCodeServerException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*Batch) CreateJobQueueRequest Uses

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 successfully.

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 Uses

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 Uses

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

To delete a compute environment

This example deletes the P2OnDemand compute environment.

Code:

svc := batch.New(session.New())
input := &batch.DeleteComputeEnvironmentInput{
    ComputeEnvironment: aws.String("P2OnDemand"),
}

result, err := svc.DeleteComputeEnvironment(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case batch.ErrCodeClientException:
            fmt.Println(batch.ErrCodeClientException, aerr.Error())
        case batch.ErrCodeServerException:
            fmt.Println(batch.ErrCodeServerException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*Batch) DeleteComputeEnvironmentRequest Uses

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 successfully.

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 Uses

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 Uses

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

To delete a job queue

This example deletes the GPGPU job queue.

Code:

svc := batch.New(session.New())
input := &batch.DeleteJobQueueInput{
    JobQueue: aws.String("GPGPU"),
}

result, err := svc.DeleteJobQueue(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case batch.ErrCodeClientException:
            fmt.Println(batch.ErrCodeClientException, aerr.Error())
        case batch.ErrCodeServerException:
            fmt.Println(batch.ErrCodeServerException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*Batch) DeleteJobQueueRequest Uses

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 successfully.

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 Uses

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 Uses

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

To deregister a job definition

This example deregisters a job definition called sleep10.

Code:

svc := batch.New(session.New())
input := &batch.DeregisterJobDefinitionInput{
    JobDefinition: aws.String("sleep10"),
}

result, err := svc.DeregisterJobDefinition(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case batch.ErrCodeClientException:
            fmt.Println(batch.ErrCodeClientException, aerr.Error())
        case batch.ErrCodeServerException:
            fmt.Println(batch.ErrCodeServerException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*Batch) DeregisterJobDefinitionRequest Uses

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 successfully.

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 Uses

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 Uses

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

To describe a compute environment

This example describes the P2OnDemand compute environment.

Code:

svc := batch.New(session.New())
input := &batch.DescribeComputeEnvironmentsInput{
    ComputeEnvironments: []*string{
        aws.String("P2OnDemand"),
    },
}

result, err := svc.DescribeComputeEnvironments(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case batch.ErrCodeClientException:
            fmt.Println(batch.ErrCodeClientException, aerr.Error())
        case batch.ErrCodeServerException:
            fmt.Println(batch.ErrCodeServerException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*Batch) DescribeComputeEnvironmentsPages Uses

func (c *Batch) DescribeComputeEnvironmentsPages(input *DescribeComputeEnvironmentsInput, fn func(*DescribeComputeEnvironmentsOutput, bool) bool) error

DescribeComputeEnvironmentsPages iterates over the pages of a DescribeComputeEnvironments operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeComputeEnvironments method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeComputeEnvironments operation.
pageNum := 0
err := client.DescribeComputeEnvironmentsPages(params,
    func(page *batch.DescribeComputeEnvironmentsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Batch) DescribeComputeEnvironmentsPagesWithContext Uses

func (c *Batch) DescribeComputeEnvironmentsPagesWithContext(ctx aws.Context, input *DescribeComputeEnvironmentsInput, fn func(*DescribeComputeEnvironmentsOutput, bool) bool, opts ...request.Option) error

DescribeComputeEnvironmentsPagesWithContext same as DescribeComputeEnvironmentsPages except it takes a Context and allows setting request options on the pages.

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) DescribeComputeEnvironmentsRequest Uses

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 successfully.

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 Uses

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 Uses

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

To describe active job definitions

This example describes all of your active job definitions.

Code:

svc := batch.New(session.New())
input := &batch.DescribeJobDefinitionsInput{
    Status: aws.String("ACTIVE"),
}

result, err := svc.DescribeJobDefinitions(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case batch.ErrCodeClientException:
            fmt.Println(batch.ErrCodeClientException, aerr.Error())
        case batch.ErrCodeServerException:
            fmt.Println(batch.ErrCodeServerException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*Batch) DescribeJobDefinitionsPages Uses

func (c *Batch) DescribeJobDefinitionsPages(input *DescribeJobDefinitionsInput, fn func(*DescribeJobDefinitionsOutput, bool) bool) error

DescribeJobDefinitionsPages iterates over the pages of a DescribeJobDefinitions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeJobDefinitions method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeJobDefinitions operation.
pageNum := 0
err := client.DescribeJobDefinitionsPages(params,
    func(page *batch.DescribeJobDefinitionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Batch) DescribeJobDefinitionsPagesWithContext Uses

func (c *Batch) DescribeJobDefinitionsPagesWithContext(ctx aws.Context, input *DescribeJobDefinitionsInput, fn func(*DescribeJobDefinitionsOutput, bool) bool, opts ...request.Option) error

DescribeJobDefinitionsPagesWithContext same as DescribeJobDefinitionsPages except it takes a Context and allows setting request options on the pages.

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) DescribeJobDefinitionsRequest Uses

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 successfully.

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 Uses

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 Uses

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

To describe a job queue

This example describes the HighPriority job queue.

Code:

svc := batch.New(session.New())
input := &batch.DescribeJobQueuesInput{
    JobQueues: []*string{
        aws.String("HighPriority"),
    },
}

result, err := svc.DescribeJobQueues(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case batch.ErrCodeClientException:
            fmt.Println(batch.ErrCodeClientException, aerr.Error())
        case batch.ErrCodeServerException:
            fmt.Println(batch.ErrCodeServerException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*Batch) DescribeJobQueuesPages Uses

func (c *Batch) DescribeJobQueuesPages(input *DescribeJobQueuesInput, fn func(*DescribeJobQueuesOutput, bool) bool) error

DescribeJobQueuesPages iterates over the pages of a DescribeJobQueues operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeJobQueues method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeJobQueues operation.
pageNum := 0
err := client.DescribeJobQueuesPages(params,
    func(page *batch.DescribeJobQueuesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Batch) DescribeJobQueuesPagesWithContext Uses

func (c *Batch) DescribeJobQueuesPagesWithContext(ctx aws.Context, input *DescribeJobQueuesInput, fn func(*DescribeJobQueuesOutput, bool) bool, opts ...request.Option) error

DescribeJobQueuesPagesWithContext same as DescribeJobQueuesPages except it takes a Context and allows setting request options on the pages.

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) DescribeJobQueuesRequest Uses

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 successfully.

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 Uses

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 Uses

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

To describe a specific job

This example describes a job with the specified job ID.

Code:

svc := batch.New(session.New())
input := &batch.DescribeJobsInput{
    Jobs: []*string{
        aws.String("24fa2d7a-64c4-49d2-8b47-f8da4fbde8e9"),
    },
}

result, err := svc.DescribeJobs(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case batch.ErrCodeClientException:
            fmt.Println(batch.ErrCodeClientException, aerr.Error())
        case batch.ErrCodeServerException:
            fmt.Println(batch.ErrCodeServerException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*Batch) DescribeJobsRequest Uses

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 successfully.

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 Uses

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 Uses

func (c *Batch) ListJobs(input *ListJobsInput) (*ListJobsOutput, error)

ListJobs API operation for AWS Batch.

Returns a list of AWS Batch jobs.

You must specify only one of the following:

* a job queue ID to return a list of jobs in that job queue

* a multi-node parallel job ID to return a list of that job's nodes

* an array job ID to return a list of that job's children

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

To list running jobs

This example lists the running jobs in the HighPriority job queue.

Code:

svc := batch.New(session.New())
input := &batch.ListJobsInput{
    JobQueue: aws.String("HighPriority"),
}

result, err := svc.ListJobs(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case batch.ErrCodeClientException:
            fmt.Println(batch.ErrCodeClientException, aerr.Error())
        case batch.ErrCodeServerException:
            fmt.Println(batch.ErrCodeServerException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

To list submitted jobs

This example lists jobs in the HighPriority job queue that are in the SUBMITTED job status.

Code:

svc := batch.New(session.New())
input := &batch.ListJobsInput{
    JobQueue:  aws.String("HighPriority"),
    JobStatus: aws.String("SUBMITTED"),
}

result, err := svc.ListJobs(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case batch.ErrCodeClientException:
            fmt.Println(batch.ErrCodeClientException, aerr.Error())
        case batch.ErrCodeServerException:
            fmt.Println(batch.ErrCodeServerException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*Batch) ListJobsPages Uses

func (c *Batch) ListJobsPages(input *ListJobsInput, fn func(*ListJobsOutput, bool) bool) error

ListJobsPages iterates over the pages of a ListJobs operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListJobs method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListJobs operation.
pageNum := 0
err := client.ListJobsPages(params,
    func(page *batch.ListJobsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Batch) ListJobsPagesWithContext Uses

func (c *Batch) ListJobsPagesWithContext(ctx aws.Context, input *ListJobsInput, fn func(*ListJobsOutput, bool) bool, opts ...request.Option) error

ListJobsPagesWithContext same as ListJobsPages except it takes a Context and allows setting request options on the pages.

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) ListJobsRequest Uses

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 successfully.

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 Uses

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 Uses

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

To register a job definition

This example registers a job definition for a simple container job.

Code:

svc := batch.New(session.New())
input := &batch.RegisterJobDefinitionInput{
    ContainerProperties: &batch.ContainerProperties{
        Command: []*string{
            aws.String("sleep"),
            aws.String("10"),
        },
        Image:  aws.String("busybox"),
        Memory: aws.Int64(128),
        Vcpus:  aws.Int64(1),
    },
    JobDefinitionName: aws.String("sleep10"),
    Type:              aws.String("container"),
}

result, err := svc.RegisterJobDefinition(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case batch.ErrCodeClientException:
            fmt.Println(batch.ErrCodeClientException, aerr.Error())
        case batch.ErrCodeServerException:
            fmt.Println(batch.ErrCodeServerException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*Batch) RegisterJobDefinitionRequest Uses

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 successfully.

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 Uses

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 Uses

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

To submit a job to a queue

This example submits a simple container job called example to the HighPriority job queue.

Code:

svc := batch.New(session.New())
input := &batch.SubmitJobInput{
    JobDefinition: aws.String("sleep60"),
    JobName:       aws.String("example"),
    JobQueue:      aws.String("HighPriority"),
}

result, err := svc.SubmitJob(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case batch.ErrCodeClientException:
            fmt.Println(batch.ErrCodeClientException, aerr.Error())
        case batch.ErrCodeServerException:
            fmt.Println(batch.ErrCodeServerException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*Batch) SubmitJobRequest Uses

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 successfully.

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 Uses

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 Uses

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

To terminate a job

This example terminates a job with the specified job ID.

Code:

svc := batch.New(session.New())
input := &batch.TerminateJobInput{
    JobId:  aws.String("61e743ed-35e4-48da-b2de-5c8333821c84"),
    Reason: aws.String("Terminating job."),
}

result, err := svc.TerminateJob(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case batch.ErrCodeClientException:
            fmt.Println(batch.ErrCodeClientException, aerr.Error())
        case batch.ErrCodeServerException:
            fmt.Println(batch.ErrCodeServerException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*Batch) TerminateJobRequest Uses

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 successfully.

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 Uses

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 Uses

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

To update a compute environment

This example disables the P2OnDemand compute environment so it can be deleted.

Code:

svc := batch.New(session.New())
input := &batch.UpdateComputeEnvironmentInput{
    ComputeEnvironment: aws.String("P2OnDemand"),
    State:              aws.String("DISABLED"),
}

result, err := svc.UpdateComputeEnvironment(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case batch.ErrCodeClientException:
            fmt.Println(batch.ErrCodeClientException, aerr.Error())
        case batch.ErrCodeServerException:
            fmt.Println(batch.ErrCodeServerException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*Batch) UpdateComputeEnvironmentRequest Uses

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 successfully.

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 Uses

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 Uses

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

To update a job queue

This example disables a job queue so that it can be deleted.

Code:

svc := batch.New(session.New())
input := &batch.UpdateJobQueueInput{
    JobQueue: aws.String("GPGPU"),
    State:    aws.String("DISABLED"),
}

result, err := svc.UpdateJobQueue(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case batch.ErrCodeClientException:
            fmt.Println(batch.ErrCodeClientException, aerr.Error())
        case batch.ErrCodeServerException:
            fmt.Println(batch.ErrCodeServerException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*Batch) UpdateJobQueueRequest Uses

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 successfully.

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 Uses

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 Uses

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 Uses

func (s CancelJobInput) GoString() string

GoString returns the string representation

func (*CancelJobInput) SetJobId Uses

func (s *CancelJobInput) SetJobId(v string) *CancelJobInput

SetJobId sets the JobId field's value.

func (*CancelJobInput) SetReason Uses

func (s *CancelJobInput) SetReason(v string) *CancelJobInput

SetReason sets the Reason field's value.

func (CancelJobInput) String Uses

func (s CancelJobInput) String() string

String returns the string representation

func (*CancelJobInput) Validate Uses

func (s *CancelJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CancelJobOutput Uses

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

func (CancelJobOutput) GoString Uses

func (s CancelJobOutput) GoString() string

GoString returns the string representation

func (CancelJobOutput) String Uses

func (s CancelJobOutput) String() string

String returns the string representation

type ComputeEnvironmentDetail Uses

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.
    //
    // If the state is ENABLED, then the AWS Batch scheduler can attempt to place
    // jobs from an associated job queue on the compute resources within the environment.
    // If the compute environment is managed, then it can scale its instances out
    // or in automatically, based on the job queue demand.
    //
    // If the state is DISABLED, then the AWS Batch scheduler does not attempt to
    // place jobs within the environment. Jobs in a STARTING or RUNNING state continue
    // to progress normally. Managed compute environments in the DISABLED state
    // do not scale out. However, they scale in to minvCpus value after instances
    // become idle.
    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 Uses

func (s ComputeEnvironmentDetail) GoString() string

GoString returns the string representation

func (*ComputeEnvironmentDetail) SetComputeEnvironmentArn Uses

func (s *ComputeEnvironmentDetail) SetComputeEnvironmentArn(v string) *ComputeEnvironmentDetail

SetComputeEnvironmentArn sets the ComputeEnvironmentArn field's value.

func (*ComputeEnvironmentDetail) SetComputeEnvironmentName Uses

func (s *ComputeEnvironmentDetail) SetComputeEnvironmentName(v string) *ComputeEnvironmentDetail

SetComputeEnvironmentName sets the ComputeEnvironmentName field's value.

func (*ComputeEnvironmentDetail) SetComputeResources Uses

func (s *ComputeEnvironmentDetail) SetComputeResources(v *ComputeResource) *ComputeEnvironmentDetail

SetComputeResources sets the ComputeResources field's value.

func (*ComputeEnvironmentDetail) SetEcsClusterArn Uses

func (s *ComputeEnvironmentDetail) SetEcsClusterArn(v string) *ComputeEnvironmentDetail

SetEcsClusterArn sets the EcsClusterArn field's value.

func (*ComputeEnvironmentDetail) SetServiceRole Uses

func (s *ComputeEnvironmentDetail) SetServiceRole(v string) *ComputeEnvironmentDetail

SetServiceRole sets the ServiceRole field's value.

func (*ComputeEnvironmentDetail) SetState Uses

func (s *ComputeEnvironmentDetail) SetState(v string) *ComputeEnvironmentDetail

SetState sets the State field's value.

func (*ComputeEnvironmentDetail) SetStatus Uses

func (s *ComputeEnvironmentDetail) SetStatus(v string) *ComputeEnvironmentDetail

SetStatus sets the Status field's value.

func (*ComputeEnvironmentDetail) SetStatusReason Uses

func (s *ComputeEnvironmentDetail) SetStatusReason(v string) *ComputeEnvironmentDetail

SetStatusReason sets the StatusReason field's value.

func (*ComputeEnvironmentDetail) SetType Uses

func (s *ComputeEnvironmentDetail) SetType(v string) *ComputeEnvironmentDetail

SetType sets the Type field's value.

func (ComputeEnvironmentDetail) String Uses

func (s ComputeEnvironmentDetail) String() string

String returns the string representation

type ComputeEnvironmentOrder Uses

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 Uses

func (s ComputeEnvironmentOrder) GoString() string

GoString returns the string representation

func (*ComputeEnvironmentOrder) SetComputeEnvironment Uses

func (s *ComputeEnvironmentOrder) SetComputeEnvironment(v string) *ComputeEnvironmentOrder

SetComputeEnvironment sets the ComputeEnvironment field's value.

func (*ComputeEnvironmentOrder) SetOrder Uses

func (s *ComputeEnvironmentOrder) SetOrder(v int64) *ComputeEnvironmentOrder

SetOrder sets the Order field's value.

func (ComputeEnvironmentOrder) String Uses

func (s ComputeEnvironmentOrder) String() string

String returns the string representation

func (*ComputeEnvironmentOrder) Validate Uses

func (s *ComputeEnvironmentOrder) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ComputeResource Uses

type ComputeResource struct {

    // The maximum percentage that a Spot Instance price can be when compared with
    // the On-Demand price for that instance type before instances are launched.
    // For example, if your maximum percentage is 20%, then the Spot price must
    // be below 20% of the current On-Demand price for that EC2 instance. You always
    // pay the lowest (market) price and never more than your maximum percentage.
    // If you leave this field empty, the default value is 100% of the On-Demand
    // price.
    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 (https://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 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 launch template to use for your compute resources. Any other compute
    // resource parameters that you specify in a CreateComputeEnvironment API operation
    // override the same parameters in the launch template. You must specify either
    // the launch template ID or launch template name in the request, but not both.
    // For more information, see Launch Template Support (https://docs.aws.amazon.com/batch/latest/userguide/launch-templates.html)
    // in the AWS Batch User Guide.
    LaunchTemplate *LaunchTemplateSpecification `locationName:"launchTemplate" type:"structure"`

    // 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 (even
    // if the compute environment is DISABLED).
    //
    // MinvCpus is a required field
    MinvCpus *int64 `locationName:"minvCpus" type:"integer" required:"true"`

    // The Amazon EC2 placement group to associate with your compute resources.
    // If you intend to submit multi-node parallel jobs to your compute environment,
    // you should consider creating a cluster placement group and associate it with
    // your compute resources. This keeps your multi-node parallel job on a logical
    // grouping of instances within a single Availability Zone with high network
    // flow potential. For more information, see Placement Groups (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html)
    // in the Amazon EC2 User Guide for Linux Instances.
    PlacementGroup *string `locationName:"placementGroup" type:"string"`

    // The EC2 security group that is associated with instances launched in the
    // compute environment.
    SecurityGroupIds []*string `locationName:"securityGroupIds" type:"list"`

    // The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied
    // to a SPOT compute environment. For more information, see Amazon EC2 Spot
    // Fleet Role (https://docs.aws.amazon.com/batch/latest/userguide/spot_fleet_IAM_role.html)
    // in the AWS Batch User Guide.
    SpotIamFleetRole *string `locationName:"spotIamFleetRole" type:"string"`

    // The VPC subnets into which the compute resources are launched. For more information,
    // see VPCs and Subnets (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html)
    // in the Amazon VPC User Guide.
    //
    // 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. For AWS Batch, these take the form of "String1": "String2",
    // where String1 is the tag key and String2 is the tag value—for example,
    // { "Name": "AWS Batch Instance - C4OnDemand" }.
    Tags map[string]*string `locationName:"tags" type:"map"`

    // The type of compute environment: EC2 or SPOT.
    //
    // 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 Uses

func (s ComputeResource) GoString() string

GoString returns the string representation

func (*ComputeResource) SetBidPercentage Uses

func (s *ComputeResource) SetBidPercentage(v int64) *ComputeResource

SetBidPercentage sets the BidPercentage field's value.

func (*ComputeResource) SetDesiredvCpus Uses

func (s *ComputeResource) SetDesiredvCpus(v int64) *ComputeResource

SetDesiredvCpus sets the DesiredvCpus field's value.

func (*ComputeResource) SetEc2KeyPair Uses

func (s *ComputeResource) SetEc2KeyPair(v string) *ComputeResource

SetEc2KeyPair sets the Ec2KeyPair field's value.

func (*ComputeResource) SetImageId Uses

func (s *ComputeResource) SetImageId(v string) *ComputeResource

SetImageId sets the ImageId field's value.

func (*ComputeResource) SetInstanceRole Uses

func (s *ComputeResource) SetInstanceRole(v string) *ComputeResource

SetInstanceRole sets the InstanceRole field's value.

func (*ComputeResource) SetInstanceTypes Uses

func (s *ComputeResource) SetInstanceTypes(v []*string) *ComputeResource

SetInstanceTypes sets the InstanceTypes field's value.

func (*ComputeResource) SetLaunchTemplate Uses

func (s *ComputeResource) SetLaunchTemplate(v *LaunchTemplateSpecification) *ComputeResource

SetLaunchTemplate sets the LaunchTemplate field's value.

func (*ComputeResource) SetMaxvCpus Uses

func (s *ComputeResource) SetMaxvCpus(v int64) *ComputeResource

SetMaxvCpus sets the MaxvCpus field's value.

func (*ComputeResource) SetMinvCpus Uses

func (s *ComputeResource) SetMinvCpus(v int64) *ComputeResource

SetMinvCpus sets the MinvCpus field's value.

func (*ComputeResource) SetPlacementGroup Uses

func (s *ComputeResource) SetPlacementGroup(v string) *ComputeResource

SetPlacementGroup sets the PlacementGroup field's value.

func (*ComputeResource) SetSecurityGroupIds Uses

func (s *ComputeResource) SetSecurityGroupIds(v []*string) *ComputeResource

SetSecurityGroupIds sets the SecurityGroupIds field's value.

func (*ComputeResource) SetSpotIamFleetRole Uses

func (s *ComputeResource) SetSpotIamFleetRole(v string) *ComputeResource

SetSpotIamFleetRole sets the SpotIamFleetRole field's value.

func (*ComputeResource) SetSubnets Uses

func (s *ComputeResource) SetSubnets(v []*string) *ComputeResource

SetSubnets sets the Subnets field's value.

func (*ComputeResource) SetTags Uses

func (s *ComputeResource) SetTags(v map[string]*string) *ComputeResource

SetTags sets the Tags field's value.

func (*ComputeResource) SetType Uses

func (s *ComputeResource) SetType(v string) *ComputeResource

SetType sets the Type field's value.

func (ComputeResource) String Uses

func (s ComputeResource) String() string

String returns the string representation

func (*ComputeResource) Validate Uses

func (s *ComputeResource) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ComputeResourceUpdate Uses

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 Uses

func (s ComputeResourceUpdate) GoString() string

GoString returns the string representation

func (*ComputeResourceUpdate) SetDesiredvCpus Uses

func (s *ComputeResourceUpdate) SetDesiredvCpus(v int64) *ComputeResourceUpdate

SetDesiredvCpus sets the DesiredvCpus field's value.

func (*ComputeResourceUpdate) SetMaxvCpus Uses

func (s *ComputeResourceUpdate) SetMaxvCpus(v int64) *ComputeResourceUpdate

SetMaxvCpus sets the MaxvCpus field's value.

func (*ComputeResourceUpdate) SetMinvCpus Uses

func (s *ComputeResourceUpdate) SetMinvCpus(v int64) *ComputeResourceUpdate

SetMinvCpus sets the MinvCpus field's value.

func (ComputeResourceUpdate) String Uses

func (s ComputeResourceUpdate) String() string

String returns the string representation

type ContainerDetail Uses

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 instance type of the underlying host infrastructure of a multi-node parallel
    // job.
    InstanceType *string `locationName:"instanceType" type:"string"`

    // The Amazon Resource Name (ARN) associated with the job upon execution.
    JobRoleArn *string `locationName:"jobRoleArn" type:"string"`

    // Linux-specific modifications that are applied to the container, such as details
    // for device mappings.
    LinuxParameters *LinuxParameters `locationName:"linuxParameters" type:"structure"`

    // 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"`

    // The network interfaces associated with the job.
    NetworkInterfaces []*NetworkInterface `locationName:"networkInterfaces" 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 type and amount of a resource to assign to a container. Currently, the
    // only supported resource is GPU.
    ResourceRequirements []*ResourceRequirement `locationName:"resourceRequirements" type:"list"`

    // 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 Uses

func (s ContainerDetail) GoString() string

GoString returns the string representation

func (*ContainerDetail) SetCommand Uses

func (s *ContainerDetail) SetCommand(v []*string) *ContainerDetail

SetCommand sets the Command field's value.

func (*ContainerDetail) SetContainerInstanceArn Uses

func (s *ContainerDetail) SetContainerInstanceArn(v string) *ContainerDetail

SetContainerInstanceArn sets the ContainerInstanceArn field's value.

func (*ContainerDetail) SetEnvironment Uses

func (s *ContainerDetail) SetEnvironment(v []*KeyValuePair) *ContainerDetail

SetEnvironment sets the Environment field's value.

func (*ContainerDetail) SetExitCode Uses

func (s *ContainerDetail) SetExitCode(v int64) *ContainerDetail

SetExitCode sets the ExitCode field's value.

func (*ContainerDetail) SetImage Uses

func (s *ContainerDetail) SetImage(v string) *ContainerDetail

SetImage sets the Image field's value.

func (*ContainerDetail) SetInstanceType Uses

func (s *ContainerDetail) SetInstanceType(v string) *ContainerDetail

SetInstanceType sets the InstanceType field's value.

func (*ContainerDetail) SetJobRoleArn Uses

func (s *ContainerDetail) SetJobRoleArn(v string) *ContainerDetail

SetJobRoleArn sets the JobRoleArn field's value.

func (*ContainerDetail) SetLinuxParameters Uses

func (s *ContainerDetail) SetLinuxParameters(v *LinuxParameters) *ContainerDetail

SetLinuxParameters sets the LinuxParameters field's value.

func (*ContainerDetail) SetLogStreamName Uses

func (s *ContainerDetail) SetLogStreamName(v string) *ContainerDetail

SetLogStreamName sets the LogStreamName field's value.

func (*ContainerDetail) SetMemory Uses

func (s *ContainerDetail) SetMemory(v int64) *ContainerDetail

SetMemory sets the Memory field's value.

func (*ContainerDetail) SetMountPoints Uses

func (s *ContainerDetail) SetMountPoints(v []*MountPoint) *ContainerDetail

SetMountPoints sets the MountPoints field's value.

func (*ContainerDetail) SetNetworkInterfaces Uses

func (s *ContainerDetail) SetNetworkInterfaces(v []*NetworkInterface) *ContainerDetail

SetNetworkInterfaces sets the NetworkInterfaces field's value.

func (*ContainerDetail) SetPrivileged Uses

func (s *ContainerDetail) SetPrivileged(v bool) *ContainerDetail

SetPrivileged sets the Privileged field's value.

func (*ContainerDetail) SetReadonlyRootFilesystem Uses

func (s *ContainerDetail) SetReadonlyRootFilesystem(v bool) *ContainerDetail

SetReadonlyRootFilesystem sets the ReadonlyRootFilesystem field's value.

func (*ContainerDetail) SetReason Uses

func (s *ContainerDetail) SetReason(v string) *ContainerDetail

SetReason sets the Reason field's value.

func (*ContainerDetail) SetResourceRequirements Uses

func (s *ContainerDetail) SetResourceRequirements(v []*ResourceRequirement) *ContainerDetail

SetResourceRequirements sets the ResourceRequirements field's value.

func (*ContainerDetail) SetTaskArn Uses

func (s *ContainerDetail) SetTaskArn(v string) *ContainerDetail

SetTaskArn sets the TaskArn field's value.

func (*ContainerDetail) SetUlimits Uses

func (s *ContainerDetail) SetUlimits(v []*Ulimit) *ContainerDetail

SetUlimits sets the Ulimits field's value.

func (*ContainerDetail) SetUser Uses

func (s *ContainerDetail) SetUser(v string) *ContainerDetail

SetUser sets the User field's value.

func (*ContainerDetail) SetVcpus Uses

func (s *ContainerDetail) SetVcpus(v int64) *ContainerDetail

SetVcpus sets the Vcpus field's value.

func (*ContainerDetail) SetVolumes Uses

func (s *ContainerDetail) SetVolumes(v []*Volume) *ContainerDetail

SetVolumes sets the Volumes field's value.

func (ContainerDetail) String Uses

func (s ContainerDetail) String() string

String returns the string representation

type ContainerOverrides Uses

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 instance type to use for a multi-node parallel job. This parameter is
    // not valid for single-node container jobs.
    InstanceType *string `locationName:"instanceType" type:"string"`

    // 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 type and amount of a resource to assign to a container. This value overrides
    // the value set in the job definition. Currently, the only supported resource
    // is GPU.
    ResourceRequirements []*ResourceRequirement `locationName:"resourceRequirements" type:"list"`

    // 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 Uses

func (s ContainerOverrides) GoString() string

GoString returns the string representation

func (*ContainerOverrides) SetCommand Uses

func (s *ContainerOverrides) SetCommand(v []*string) *ContainerOverrides

SetCommand sets the Command field's value.

func (*ContainerOverrides) SetEnvironment Uses

func (s *ContainerOverrides) SetEnvironment(v []*KeyValuePair) *ContainerOverrides

SetEnvironment sets the Environment field's value.

func (*ContainerOverrides) SetInstanceType Uses

func (s *ContainerOverrides) SetInstanceType(v string) *ContainerOverrides

SetInstanceType sets the InstanceType field's value.

func (*ContainerOverrides) SetMemory Uses

func (s *ContainerOverrides) SetMemory(v int64) *ContainerOverrides

SetMemory sets the Memory field's value.

func (*ContainerOverrides) SetResourceRequirements Uses

func (s *ContainerOverrides) SetResourceRequirements(v []*ResourceRequirement) *ContainerOverrides

SetResourceRequirements sets the ResourceRequirements field's value.

func (*ContainerOverrides) SetVcpus Uses

func (s *ContainerOverrides) SetVcpus(v int64) *ContainerOverrides

SetVcpus sets the Vcpus field's value.

func (ContainerOverrides) String Uses

func (s ContainerOverrides) String() string

String returns the string representation

func (*ContainerOverrides) Validate Uses

func (s *ContainerOverrides) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ContainerProperties Uses

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/api/v1.23/#create-a-container)
    // section of the Docker Remote API (https://docs.docker.com/engine/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/api/v1.23/#create-a-container)
    // section of the Docker Remote API (https://docs.docker.com/engine/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/api/v1.23/#create-a-container)
    // section of the Docker Remote API (https://docs.docker.com/engine/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 *string `locationName:"image" type:"string"`

    // The instance type to use for a multi-node parallel job. Currently all node
    // groups in a multi-node parallel job must use the same instance type. This
    // parameter is not valid for single-node container jobs.
    InstanceType *string `locationName:"instanceType" type:"string"`

    // The Amazon Resource Name (ARN) of the IAM role that the container can assume
    // for AWS permissions.
    JobRoleArn *string `locationName:"jobRoleArn" type:"string"`

    // Linux-specific modifications that are applied to the container, such as details
    // for device mappings.
    LinuxParameters *LinuxParameters `locationName:"linuxParameters" type:"structure"`

    // 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/api/v1.23/#create-a-container)
    // section of the Docker Remote API (https://docs.docker.com/engine/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 (https://docs.aws.amazon.com/batch/latest/userguide/memory-management.html)
    // in the AWS Batch User Guide.
    Memory *int64 `locationName:"memory" type:"integer"`

    // The mount points for data volumes in your container. This parameter maps
    // to Volumes in the Create a container (https://docs.docker.com/engine/api/v1.23/#create-a-container)
    // section of the Docker Remote API (https://docs.docker.com/engine/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/api/v1.23/#create-a-container)
    // section of the Docker Remote API (https://docs.docker.com/engine/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/api/v1.23/#create-a-container) section of
    // the Docker Remote API (https://docs.docker.com/engine/api/v1.23/) and the
    // --read-only option to docker run.
    ReadonlyRootFilesystem *bool `locationName:"readonlyRootFilesystem" type:"boolean"`

    // The type and amount of a resource to assign to a container. Currently, the
    // only supported resource is GPU.
    ResourceRequirements []*ResourceRequirement `locationName:"resourceRequirements" type:"list"`

    // A list of ulimits to set in the container. This parameter maps to Ulimits
    // in the Create a container (https://docs.docker.com/engine/api/v1.23/#create-a-container)
    // section of the Docker Remote API (https://docs.docker.com/engine/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/api/v1.23/#create-a-container)
    // section of the Docker Remote API (https://docs.docker.com/engine/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/api/v1.23/#create-a-container)
    // section of the Docker Remote API (https://docs.docker.com/engine/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 *int64 `locationName:"vcpus" type:"integer"`

    // 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 Uses

func (s ContainerProperties) GoString() string

GoString returns the string representation

func (*ContainerProperties) SetCommand Uses

func (s *ContainerProperties) SetCommand(v []*string) *ContainerProperties

SetCommand sets the Command field's value.

func (*ContainerProperties) SetEnvironment Uses

func (s *ContainerProperties) SetEnvironment(v []*KeyValuePair) *ContainerProperties

SetEnvironment sets the Environment field's value.

func (*ContainerProperties) SetImage Uses

func (s *ContainerProperties) SetImage(v string) *ContainerProperties

SetImage sets the Image field's value.

func (*ContainerProperties) SetInstanceType Uses

func (s *ContainerProperties) SetInstanceType(v string) *ContainerProperties

SetInstanceType sets the InstanceType field's value.

func (*ContainerProperties) SetJobRoleArn Uses

func (s *ContainerProperties) SetJobRoleArn(v string) *ContainerProperties

SetJobRoleArn sets the JobRoleArn field's value.

func (*ContainerProperties) SetLinuxParameters Uses

func (s *ContainerProperties) SetLinuxParameters(v *LinuxParameters) *ContainerProperties

SetLinuxParameters sets the LinuxParameters field's value.

func (*ContainerProperties) SetMemory Uses

func (s *ContainerProperties) SetMemory(v int64) *ContainerProperties

SetMemory sets the Memory field's value.

func (*ContainerProperties) SetMountPoints Uses

func (s *ContainerProperties) SetMountPoints(v []*MountPoint) *ContainerProperties

SetMountPoints sets the MountPoints field's value.

func (*ContainerProperties) SetPrivileged Uses

func (s *ContainerProperties) SetPrivileged(v bool) *ContainerProperties

SetPrivileged sets the Privileged field's value.

func (*ContainerProperties) SetReadonlyRootFilesystem Uses

func (s *ContainerProperties) SetReadonlyRootFilesystem(v bool) *ContainerProperties

SetReadonlyRootFilesystem sets the ReadonlyRootFilesystem field's value.

func (*ContainerProperties) SetResourceRequirements Uses

func (s *ContainerProperties) SetResourceRequirements(v []*ResourceRequirement) *ContainerProperties

SetResourceRequirements sets the ResourceRequirements field's value.

func (*ContainerProperties) SetUlimits Uses

func (s *ContainerProperties) SetUlimits(v []*Ulimit) *ContainerProperties

SetUlimits sets the Ulimits field's value.

func (*ContainerProperties) SetUser Uses

func (s *ContainerProperties) SetUser(v string) *ContainerProperties

SetUser sets the User field's value.

func (*ContainerProperties) SetVcpus Uses

func (s *ContainerProperties) SetVcpus(v int64) *ContainerProperties

SetVcpus sets the Vcpus field's value.

func (*ContainerProperties) SetVolumes Uses

func (s *ContainerProperties) SetVolumes(v []*Volume) *ContainerProperties

SetVolumes sets the Volumes field's value.

func (ContainerProperties) String Uses

func (s ContainerProperties) String() string

String returns the string representation

func (*ContainerProperties) Validate Uses

func (s *ContainerProperties) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ContainerSummary Uses

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 Uses

func (s ContainerSummary) GoString() string

GoString returns the string representation

func (*ContainerSummary) SetExitCode Uses

func (s *ContainerSummary) SetExitCode(v int64) *ContainerSummary

SetExitCode sets the ExitCode field's value.

func (*ContainerSummary) SetReason Uses

func (s *ContainerSummary) SetReason(v string) *ContainerSummary

SetReason sets the Reason field's value.

func (ContainerSummary) String Uses

func (s ContainerSummary) String() string

String returns the string representation

type CreateComputeEnvironmentInput Uses

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. For more information,
    // see Compute Environments (https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html)
    // in the AWS Batch User Guide.
    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. For more information, see Compute Environments
    // (https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html)
    // in the AWS Batch User Guide.
    //
    // Type is a required field
    Type *string `locationName:"type" type:"string" required:"true" enum:"CEType"`
    // contains filtered or unexported fields
}

func (CreateComputeEnvironmentInput) GoString Uses

func (s CreateComputeEnvironmentInput) GoString() string

GoString returns the string representation

func (*CreateComputeEnvironmentInput) SetComputeEnvironmentName Uses

func (s *CreateComputeEnvironmentInput) SetComputeEnvironmentName(v string) *CreateComputeEnvironmentInput

SetComputeEnvironmentName sets the ComputeEnvironmentName field's value.

func (*CreateComputeEnvironmentInput) SetComputeResources Uses

func (s *CreateComputeEnvironmentInput) SetComputeResources(v *ComputeResource) *CreateComputeEnvironmentInput

SetComputeResources sets the ComputeResources field's value.

func (*CreateComputeEnvironmentInput) SetServiceRole Uses

func (s *CreateComputeEnvironmentInput) SetServiceRole(v string) *CreateComputeEnvironmentInput

SetServiceRole sets the ServiceRole field's value.

func (*CreateComputeEnvironmentInput) SetState Uses

func (s *CreateComputeEnvironmentInput) SetState(v string) *CreateComputeEnvironmentInput

SetState sets the State field's value.

func (*CreateComputeEnvironmentInput) SetType Uses

func (s *CreateComputeEnvironmentInput) SetType(v string) *CreateComputeEnvironmentInput

SetType sets the Type field's value.

func (CreateComputeEnvironmentInput) String Uses

func (s CreateComputeEnvironmentInput) String() string

String returns the string representation

func (*CreateComputeEnvironmentInput) Validate Uses

func (s *CreateComputeEnvironmentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateComputeEnvironmentOutput Uses

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 Uses

func (s CreateComputeEnvironmentOutput) GoString() string

GoString returns the string representation

func (*CreateComputeEnvironmentOutput) SetComputeEnvironmentArn Uses

func (s *CreateComputeEnvironmentOutput) SetComputeEnvironmentArn(v string) *CreateComputeEnvironmentOutput

SetComputeEnvironmentArn sets the ComputeEnvironmentArn field's value.

func (*CreateComputeEnvironmentOutput) SetComputeEnvironmentName Uses

func (s *CreateComputeEnvironmentOutput) SetComputeEnvironmentName(v string) *CreateComputeEnvironmentOutput

SetComputeEnvironmentName sets the ComputeEnvironmentName field's value.

func (CreateComputeEnvironmentOutput) String Uses

func (s CreateComputeEnvironmentOutput) String() string

String returns the string representation

type CreateJobQueueInput Uses

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 the 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 Uses

func (s CreateJobQueueInput) GoString() string

GoString returns the string representation

func (*CreateJobQueueInput) SetComputeEnvironmentOrder Uses

func (s *CreateJobQueueInput) SetComputeEnvironmentOrder(v []*ComputeEnvironmentOrder) *CreateJobQueueInput

SetComputeEnvironmentOrder sets the ComputeEnvironmentOrder field's value.

func (*CreateJobQueueInput) SetJobQueueName Uses

func (s *CreateJobQueueInput) SetJobQueueName(v string) *CreateJobQueueInput

SetJobQueueName sets the JobQueueName field's value.

func (*CreateJobQueueInput) SetPriority Uses

func (s *CreateJobQueueInput) SetPriority(v int64) *CreateJobQueueInput

SetPriority sets the Priority field's value.

func (*CreateJobQueueInput) SetState Uses

func (s *CreateJobQueueInput) SetState(v string) *CreateJobQueueInput

SetState sets the State field's value.

func (CreateJobQueueInput) String Uses

func (s CreateJobQueueInput) String() string

String returns the string representation

func (*CreateJobQueueInput) Validate Uses

func (s *CreateJobQueueInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateJobQueueOutput Uses

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 Uses

func (s CreateJobQueueOutput) GoString() string

GoString returns the string representation

func (*CreateJobQueueOutput) SetJobQueueArn Uses

func (s *CreateJobQueueOutput) SetJobQueueArn(v string) *CreateJobQueueOutput

SetJobQueueArn sets the JobQueueArn field's value.

func (*CreateJobQueueOutput) SetJobQueueName Uses

func (s *CreateJobQueueOutput) SetJobQueueName(v string) *CreateJobQueueOutput

SetJobQueueName sets the JobQueueName field's value.

func (CreateJobQueueOutput) String Uses

func (s CreateJobQueueOutput) String() string

String returns the string representation

type DeleteComputeEnvironmentInput Uses

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 Uses

func (s DeleteComputeEnvironmentInput) GoString() string

GoString returns the string representation

func (*DeleteComputeEnvironmentInput) SetComputeEnvironment Uses

func (s *DeleteComputeEnvironmentInput) SetComputeEnvironment(v string) *DeleteComputeEnvironmentInput

SetComputeEnvironment sets the ComputeEnvironment field's value.

func (DeleteComputeEnvironmentInput) String Uses

func (s DeleteComputeEnvironmentInput) String() string

String returns the string representation

func (*DeleteComputeEnvironmentInput) Validate Uses

func (s *DeleteComputeEnvironmentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteComputeEnvironmentOutput Uses

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

func (DeleteComputeEnvironmentOutput) GoString Uses

func (s DeleteComputeEnvironmentOutput) GoString() string

GoString returns the string representation

func (DeleteComputeEnvironmentOutput) String Uses

func (s DeleteComputeEnvironmentOutput) String() string

String returns the string representation

type DeleteJobQueueInput Uses

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 Uses

func (s DeleteJobQueueInput) GoString() string

GoString returns the string representation

func (*DeleteJobQueueInput) SetJobQueue Uses

func (s *DeleteJobQueueInput) SetJobQueue(v string) *DeleteJobQueueInput

SetJobQueue sets the JobQueue field's value.

func (DeleteJobQueueInput) String Uses

func (s DeleteJobQueueInput) String() string

String returns the string representation

func (*DeleteJobQueueInput) Validate Uses

func (s *DeleteJobQueueInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteJobQueueOutput Uses

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

func (DeleteJobQueueOutput) GoString Uses

func (s DeleteJobQueueOutput) GoString() string

GoString returns the string representation

func (DeleteJobQueueOutput) String Uses

func (s DeleteJobQueueOutput) String() string

String returns the string representation

type DeregisterJobDefinitionInput Uses

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 Uses

func (s DeregisterJobDefinitionInput) GoString() string

GoString returns the string representation

func (*DeregisterJobDefinitionInput) SetJobDefinition Uses

func (s *DeregisterJobDefinitionInput) SetJobDefinition(v string) *DeregisterJobDefinitionInput

SetJobDefinition sets the JobDefinition field's value.

func (DeregisterJobDefinitionInput) String Uses

func (s DeregisterJobDefinitionInput) String() string

String returns the string representation

func (*DeregisterJobDefinitionInput) Validate Uses

func (s *DeregisterJobDefinitionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeregisterJobDefinitionOutput Uses

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

func (DeregisterJobDefinitionOutput) GoString Uses

func (s DeregisterJobDefinitionOutput) GoString() string

GoString returns the string representation

func (DeregisterJobDefinitionOutput) String Uses

func (s DeregisterJobDefinitionOutput) String() string

String returns the string representation

type DescribeComputeEnvironmentsInput Uses

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 Uses

func (s DescribeComputeEnvironmentsInput) GoString() string

GoString returns the string representation

func (*DescribeComputeEnvironmentsInput) SetComputeEnvironments Uses

func (s *DescribeComputeEnvironmentsInput) SetComputeEnvironments(v []*string) *DescribeComputeEnvironmentsInput

SetComputeEnvironments sets the ComputeEnvironments field's value.

func (*DescribeComputeEnvironmentsInput) SetMaxResults Uses

func (s *DescribeComputeEnvironmentsInput) SetMaxResults(v int64) *DescribeComputeEnvironmentsInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeComputeEnvironmentsInput) SetNextToken Uses

func (s *DescribeComputeEnvironmentsInput) SetNextToken(v string) *DescribeComputeEnvironmentsInput

SetNextToken sets the NextToken field's value.

func (DescribeComputeEnvironmentsInput) String Uses

func (s DescribeComputeEnvironmentsInput) String() string

String returns the string representation

type DescribeComputeEnvironmentsOutput Uses

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 Uses

func (s DescribeComputeEnvironmentsOutput) GoString() string

GoString returns the string representation

func (*DescribeComputeEnvironmentsOutput) SetComputeEnvironments Uses

func (s *DescribeComputeEnvironmentsOutput) SetComputeEnvironments(v []*ComputeEnvironmentDetail) *DescribeComputeEnvironmentsOutput

SetComputeEnvironments sets the ComputeEnvironments field's value.

func (*DescribeComputeEnvironmentsOutput) SetNextToken Uses

func (s *DescribeComputeEnvironmentsOutput) SetNextToken(v string) *DescribeComputeEnvironmentsOutput

SetNextToken sets the NextToken field's value.

func (DescribeComputeEnvironmentsOutput) String Uses

func (s DescribeComputeEnvironmentsOutput) String() string

String returns the string representation

type DescribeJobDefinitionsInput Uses

type DescribeJobDefinitionsInput struct {

    // The name of the job definition to describe.
    JobDefinitionName *string `locationName:"jobDefinitionName" type:"string"`

    // A 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 Uses

func (s DescribeJobDefinitionsInput) GoString() string

GoString returns the string representation

func (*DescribeJobDefinitionsInput) SetJobDefinitionName Uses

func (s *DescribeJobDefinitionsInput) SetJobDefinitionName(v string) *DescribeJobDefinitionsInput

SetJobDefinitionName sets the JobDefinitionName field's value.

func (*DescribeJobDefinitionsInput) SetJobDefinitions Uses

func (s *DescribeJobDefinitionsInput) SetJobDefinitions(v []*string) *DescribeJobDefinitionsInput

SetJobDefinitions sets the JobDefinitions field's value.

func (*DescribeJobDefinitionsInput) SetMaxResults Uses

func (s *DescribeJobDefinitionsInput) SetMaxResults(v int64) *DescribeJobDefinitionsInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeJobDefinitionsInput) SetNextToken Uses

func (s *DescribeJobDefinitionsInput) SetNextToken(v string) *DescribeJobDefinitionsInput

SetNextToken sets the NextToken field's value.

func (*DescribeJobDefinitionsInput) SetStatus Uses

func (s *DescribeJobDefinitionsInput) SetStatus(v string) *DescribeJobDefinitionsInput

SetStatus sets the Status field's value.

func (DescribeJobDefinitionsInput) String Uses

func (s DescribeJobDefinitionsInput) String() string

String returns the string representation

type DescribeJobDefinitionsOutput Uses

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 Uses

func (s DescribeJobDefinitionsOutput) GoString() string

GoString returns the string representation

func (*DescribeJobDefinitionsOutput) SetJobDefinitions Uses

func (s *DescribeJobDefinitionsOutput) SetJobDefinitions(v []*JobDefinition) *DescribeJobDefinitionsOutput

SetJobDefinitions sets the JobDefinitions field's value.

func (*DescribeJobDefinitionsOutput) SetNextToken Uses

func (s *DescribeJobDefinitionsOutput) SetNextToken(v string) *DescribeJobDefinitionsOutput

SetNextToken sets the NextToken field's value.

func (DescribeJobDefinitionsOutput) String Uses

func (s DescribeJobDefinitionsOutput) String() string

String returns the string representation

type DescribeJobQueuesInput Uses

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 Uses

func (s DescribeJobQueuesInput) GoString() string

GoString returns the string representation

func (*DescribeJobQueuesInput) SetJobQueues Uses

func (s *DescribeJobQueuesInput) SetJobQueues(v []*string) *DescribeJobQueuesInput

SetJobQueues sets the JobQueues field's value.

func (*DescribeJobQueuesInput) SetMaxResults Uses

func (s *DescribeJobQueuesInput) SetMaxResults(v int64) *DescribeJobQueuesInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeJobQueuesInput) SetNextToken Uses

func (s *DescribeJobQueuesInput) SetNextToken(v string) *DescribeJobQueuesInput

SetNextToken sets the NextToken field's value.

func (DescribeJobQueuesInput) String Uses

func (s DescribeJobQueuesInput) String() string

String returns the string representation

type DescribeJobQueuesOutput Uses

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 Uses

func (s DescribeJobQueuesOutput) GoString() string

GoString returns the string representation

func (*DescribeJobQueuesOutput) SetJobQueues Uses

func (s *DescribeJobQueuesOutput) SetJobQueues(v []*JobQueueDetail) *DescribeJobQueuesOutput

SetJobQueues sets the JobQueues field's value.

func (*DescribeJobQueuesOutput) SetNextToken Uses

func (s *DescribeJobQueuesOutput) SetNextToken(v string) *DescribeJobQueuesOutput

SetNextToken sets the NextToken field's value.

func (DescribeJobQueuesOutput) String Uses

func (s DescribeJobQueuesOutput) String() string

String returns the string representation

type DescribeJobsInput Uses

type DescribeJobsInput struct {

    // A 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 Uses

func (s DescribeJobsInput) GoString() string

GoString returns the string representation

func (*DescribeJobsInput) SetJobs Uses

func (s *DescribeJobsInput) SetJobs(v []*string) *DescribeJobsInput

SetJobs sets the Jobs field's value.

func (DescribeJobsInput) String Uses

func (s DescribeJobsInput) String() string

String returns the string representation

func (*DescribeJobsInput) Validate Uses

func (s *DescribeJobsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeJobsOutput Uses

type DescribeJobsOutput struct {

    // The list of jobs.
    Jobs []*JobDetail `locationName:"jobs" type:"list"`
    // contains filtered or unexported fields
}

func (DescribeJobsOutput) GoString Uses

func (s DescribeJobsOutput) GoString() string

GoString returns the string representation

func (*DescribeJobsOutput) SetJobs Uses

func (s *DescribeJobsOutput) SetJobs(v []*JobDetail) *DescribeJobsOutput

SetJobs sets the Jobs field's value.

func (DescribeJobsOutput) String Uses

func (s DescribeJobsOutput) String() string

String returns the string representation

type Device Uses

type Device struct {

    // The path inside the container at which to expose the host device. By default
    // the hostPath value is used.
    ContainerPath *string `locationName:"containerPath" type:"string"`

    // The path for the device on the host container instance.
    //
    // HostPath is a required field
    HostPath *string `locationName:"hostPath" type:"string" required:"true"`

    // The explicit permissions to provide to the container for the device. By default,
    // the container has permissions for read, write, and mknod for the device.
    Permissions []*string `locationName:"permissions" type:"list"`
    // contains filtered or unexported fields
}

An object representing a container instance host device.

func (Device) GoString Uses

func (s Device) GoString() string

GoString returns the string representation

func (*Device) SetContainerPath Uses

func (s *Device) SetContainerPath(v string) *Device

SetContainerPath sets the ContainerPath field's value.

func (*Device) SetHostPath Uses

func (s *Device) SetHostPath(v string) *Device

SetHostPath sets the HostPath field's value.

func (*Device) SetPermissions Uses

func (s *Device) SetPermissions(v []*string) *Device

SetPermissions sets the Permissions field's value.

func (Device) String Uses

func (s Device) String() string

String returns the string representation

func (*Device) Validate Uses

func (s *Device) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Host Uses

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 this parameter contains a file location, then the data volume
    // persists at the specified location on the host container instance until you
    // delete it manually. If the source path location 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
}

Determine whether your data volume persists on the host container instance and where it is stored. If this 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) GoString Uses

func (s Host) GoString() string

GoString returns the string representation

func (*Host) SetSourcePath Uses

func (s *Host) SetSourcePath(v string) *Host

SetSourcePath sets the SourcePath field's value.

func (Host) String Uses

func (s Host) String() string

String returns the string representation

type JobDefinition Uses

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"`

    // An object with various properties specific to multi-node parallel jobs.
    NodeProperties *NodeProperties `locationName:"nodeProperties" type:"structure"`

    // 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. For more information about specifying parameters,
    // see Job Definition Parameters (https://docs.aws.amazon.com/batch/latest/userguide/job_definition_parameters.html)
    // in the AWS Batch User Guide.
    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 Uses

func (s JobDefinition) GoString() string

GoString returns the string representation

func (*JobDefinition) SetContainerProperties Uses

func (s *JobDefinition) SetContainerProperties(v *ContainerProperties) *JobDefinition

SetContainerProperties sets the ContainerProperties field's value.

func (*JobDefinition) SetJobDefinitionArn Uses

func (s *JobDefinition) SetJobDefinitionArn(v string) *JobDefinition

SetJobDefinitionArn sets the JobDefinitionArn field's value.

func (*JobDefinition) SetJobDefinitionName Uses

func (s *JobDefinition) SetJobDefinitionName(v string) *JobDefinition

SetJobDefinitionName sets the JobDefinitionName field's value.

func (*JobDefinition) SetNodeProperties Uses

func (s *JobDefinition) SetNodeProperties(v *NodeProperties) *JobDefinition

SetNodeProperties sets the NodeProperties field's value.

func (*JobDefinition) SetParameters Uses

func (s *JobDefinition) SetParameters(v map[string]*string) *JobDefinition

SetParameters sets the Parameters field's value.

func (*JobDefinition) SetRetryStrategy Uses

func (s *JobDefinition) SetRetryStrategy(v *RetryStrategy) *JobDefinition

SetRetryStrategy sets the RetryStrategy field's value.

func (*JobDefinition) SetRevision Uses

func (s *JobDefinition) SetRevision(v int64) *JobDefinition

SetRevision sets the Revision field's value.

func (*JobDefinition) SetStatus Uses

func (s *JobDefinition) SetStatus(v string) *JobDefinition

SetStatus sets the Status field's value.

func (*JobDefinition) SetTimeout Uses

func (s *JobDefinition) SetTimeout(v *JobTimeout) *JobDefinition

SetTimeout sets the Timeout field's value.

func (*JobDefinition) SetType Uses

func (s *JobDefinition) SetType(v string) *JobDefinition

SetType sets the Type field's value.

func (JobDefinition) String Uses

func (s JobDefinition) String() string

String returns the string representation

type JobDependency Uses

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 Uses

func (s JobDependency) GoString() string

GoString returns the string representation

func (*JobDependency) SetJobId Uses

func (s *JobDependency) SetJobId(v string) *JobDependency

SetJobId sets the JobId field's value.

func (*JobDependency) SetType Uses

func (s *JobDependency) SetType(v string) *JobDependency

SetType sets the Type field's value.

func (JobDependency) String Uses

func (s JobDependency) String() string

String returns the string representation

type JobDetail Uses

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 timestamp (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"`

    // An object representing the details of a node that is associated with a multi-node
    // parallel job.
    NodeDetails *NodeDetails `locationName:"nodeDetails" type:"structure"`

    // An object representing the node properties of a multi-node parallel job.
    NodeProperties *NodeProperties `locationName:"nodeProperties" type:"structure"`

    // 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 timestamp (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.
    //
    // If your jobs do not progress to STARTING, see Jobs Stuck in RUNNABLE Status
    // (https://docs.aws.amazon.com/batch/latest/userguide/troubleshooting.html#job_stuck_in_runnable)
    // in the troubleshooting section of the AWS Batch User Guide.
    //
    // 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 timestamp (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) GoString Uses

func (s JobDetail) GoString() string

GoString returns the string representation

func (*JobDetail) SetArrayProperties Uses

func (s *JobDetail) SetArrayProperties(v *ArrayPropertiesDetail) *JobDetail

SetArrayProperties sets the ArrayProperties field's value.

func (*JobDetail) SetAttempts Uses

func (s *JobDetail) SetAttempts(v []*AttemptDetail) *JobDetail

SetAttempts sets the Attempts field's value.

func (*JobDetail) SetContainer Uses

func (s *JobDetail) SetContainer(v *ContainerDetail) *JobDetail

SetContainer sets the Container field's value.

func (*JobDetail) SetCreatedAt Uses

func (s *JobDetail) SetCreatedAt(v int64) *JobDetail

SetCreatedAt sets the CreatedAt field's value.

func (*JobDetail) SetDependsOn Uses

func (s *JobDetail) SetDependsOn(v []*JobDependency) *JobDetail

SetDependsOn sets the DependsOn field's value.

func (*JobDetail) SetJobDefinition Uses

func (s *JobDetail) SetJobDefinition(v string) *JobDetail

SetJobDefinition sets the JobDefinition field's value.

func (*JobDetail) SetJobId Uses

func (s *JobDetail) SetJobId(v string) *JobDetail

SetJobId sets the JobId field's value.

func (*JobDetail) SetJobName Uses

func (s *JobDetail) SetJobName(v string) *JobDetail

SetJobName sets the JobName field's value.

func (*JobDetail) SetJobQueue Uses

func (s *JobDetail) SetJobQueue(v string) *JobDetail

SetJobQueue sets the JobQueue field's value.

func (*JobDetail) SetNodeDetails Uses

func (s *JobDetail) SetNodeDetails(v *NodeDetails) *JobDetail

SetNodeDetails sets the NodeDetails field's value.

func (*JobDetail) SetNodeProperties Uses

func (s *JobDetail) SetNodeProperties(v *NodeProperties) *JobDetail

SetNodeProperties sets the NodeProperties field's value.

func (*JobDetail) SetParameters Uses

func (s *JobDetail) SetParameters(v map[string]*string) *JobDetail

SetParameters sets the Parameters field's value.

func (*JobDetail) SetRetryStrategy Uses

func (s *JobDetail) SetRetryStrategy(v *RetryStrategy) *JobDetail

SetRetryStrategy sets the RetryStrategy field's value.

func (*JobDetail) SetStartedAt Uses

func (s *JobDetail) SetStartedAt(v int64) *JobDetail

SetStartedAt sets the StartedAt field's value.

func (*JobDetail) SetStatus Uses

func (s *JobDetail) SetStatus(v string) *JobDetail

SetStatus sets the Status field's value.

func (*JobDetail) SetStatusReason Uses

func (s *JobDetail) SetStatusReason(v string) *JobDetail

SetStatusReason sets the StatusReason field's value.

func (*JobDetail) SetStoppedAt Uses

func (s *JobDetail) SetStoppedAt(v int64) *JobDetail

SetStoppedAt sets the StoppedAt field's value.

func (*JobDetail) SetTimeout Uses

func (s *JobDetail) SetTimeout(v *JobTimeout) *JobDetail

SetTimeout sets the Timeout field's value.

func (JobDetail) String Uses

func (s JobDetail) String() string

String returns the string representation

type JobQueueDetail Uses

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 Uses

func (s JobQueueDetail) GoString() string

GoString returns the string representation

func (*JobQueueDetail) SetComputeEnvironmentOrder Uses

func (s *JobQueueDetail) SetComputeEnvironmentOrder(v []*ComputeEnvironmentOrder) *JobQueueDetail

SetComputeEnvironmentOrder sets the ComputeEnvironmentOrder field's value.

func (*JobQueueDetail) SetJobQueueArn Uses

func (s *JobQueueDetail) SetJobQueueArn(v string) *JobQueueDetail

SetJobQueueArn sets the JobQueueArn field's value.

func (*JobQueueDetail) SetJobQueueName Uses

func (s *JobQueueDetail) SetJobQueueName(v string) *JobQueueDetail

SetJobQueueName sets the JobQueueName field's value.

func (*JobQueueDetail) SetPriority Uses

func (s *JobQueueDetail) SetPriority(v int64) *JobQueueDetail

SetPriority sets the Priority field's value.

func (*JobQueueDetail) SetState Uses

func (s *JobQueueDetail) SetState(v string) *JobQueueDetail

SetState sets the State field's value.

func (*JobQueueDetail) SetStatus Uses

func (s *JobQueueDetail) SetStatus(v string) *JobQueueDetail

SetStatus sets the Status field's value.

func (*JobQueueDetail) SetStatusReason Uses

func (s *JobQueueDetail) SetStatusReason(v string) *JobQueueDetail

SetStatusReason sets the StatusReason field's value.

func (JobQueueDetail) String Uses

func (s JobQueueDetail) String() string

String returns the string representation

type JobSummary Uses

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 timestamp 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 node properties for a single node in a job summary list.
    NodeProperties *NodePropertiesSummary `locationName:"nodeProperties" type:"structure"`

    // The Unix timestamp 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 timestamp 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 Uses

func (s JobSummary) GoString() string

GoString returns the string representation

func (*JobSummary) SetArrayProperties Uses

func (s *JobSummary) SetArrayProperties(v *ArrayPropertiesSummary) *JobSummary

SetArrayProperties sets the ArrayProperties field's value.

func (*JobSummary) SetContainer Uses

func (s *JobSummary) SetContainer(v *ContainerSummary) *JobSummary

SetContainer sets the Container field's value.

func (*JobSummary) SetCreatedAt Uses

func (s *JobSummary) SetCreatedAt(v int64) *JobSummary

SetCreatedAt sets the CreatedAt field's value.

func (*JobSummary) SetJobId Uses

func (s *JobSummary) SetJobId(v string) *JobSummary

SetJobId sets the JobId field's value.

func (*JobSummary) SetJobName Uses

func (s *JobSummary) SetJobName(v string) *JobSummary

SetJobName sets the JobName field's value.

func (*JobSummary) SetNodeProperties Uses

func (s *JobSummary) SetNodeProperties(v *NodePropertiesSummary) *JobSummary

SetNodeProperties sets the NodeProperties field's value.

func (*JobSummary) SetStartedAt Uses

func (s *JobSummary) SetStartedAt(v int64) *JobSummary

SetStartedAt sets the StartedAt field's value.

func (*JobSummary) SetStatus Uses

func (s *JobSummary) SetStatus(v string) *JobSummary

SetStatus sets the Status field's value.

func (*JobSummary) SetStatusReason Uses

func (s *JobSummary) SetStatusReason(v string) *JobSummary

SetStatusReason sets the StatusReason field's value.

func (*JobSummary) SetStoppedAt Uses

func (s *JobSummary) SetStoppedAt(v int64) *JobSummary

SetStoppedAt sets the StoppedAt field's value.

func (JobSummary) String Uses

func (s JobSummary) String() string

String returns the string representation

type JobTimeout Uses

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 Uses

func (s JobTimeout) GoString() string

GoString returns the string representation

func (*JobTimeout) SetAttemptDurationSeconds Uses

func (s *JobTimeout) SetAttemptDurationSeconds(v int64) *JobTimeout

SetAttemptDurationSeconds sets the AttemptDurationSeconds field's value.

func (JobTimeout) String Uses

func (s JobTimeout) String() string

String returns the string representation

type KeyValuePair Uses

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 Uses

func (s KeyValuePair) GoString() string

GoString returns the string representation

func (*KeyValuePair) SetName Uses

func (s *KeyValuePair) SetName(v string) *KeyValuePair

SetName sets the Name field's value.

func (*KeyValuePair) SetValue Uses

func (s *KeyValuePair) SetValue(v string) *KeyValuePair

SetValue sets the Value field's value.

func (KeyValuePair) String Uses

func (s KeyValuePair) String() string

String returns the string representation

type LaunchTemplateSpecification Uses

type LaunchTemplateSpecification struct {

    // The ID of the launch template.
    LaunchTemplateId *string `locationName:"launchTemplateId" type:"string"`

    // The name of the launch template.
    LaunchTemplateName *string `locationName:"launchTemplateName" type:"string"`

    // The version number of the launch template.
    //
    // Default: The default version of the launch template.
    Version *string `locationName:"version" type:"string"`
    // contains filtered or unexported fields
}

An object representing a launch template associated with a compute resource. You must specify either the launch template ID or launch template name in the request, but not both.

func (LaunchTemplateSpecification) GoString Uses

func (s LaunchTemplateSpecification) GoString() string

GoString returns the string representation

func (*LaunchTemplateSpecification) SetLaunchTemplateId Uses

func (s *LaunchTemplateSpecification) SetLaunchTemplateId(v string) *LaunchTemplateSpecification

SetLaunchTemplateId sets the LaunchTemplateId field's value.

func (*LaunchTemplateSpecification) SetLaunchTemplateName Uses

func (s *LaunchTemplateSpecification) SetLaunchTemplateName(v string) *LaunchTemplateSpecification

SetLaunchTemplateName sets the LaunchTemplateName field's value.

func (*LaunchTemplateSpecification) SetVersion Uses

func (s *LaunchTemplateSpecification) SetVersion(v string) *LaunchTemplateSpecification

SetVersion sets the Version field's value.

func (LaunchTemplateSpecification) String Uses

func (s LaunchTemplateSpecification) String() string

String returns the string representation

type LinuxParameters Uses

type LinuxParameters struct {

    // Any host devices to expose to the container. This parameter maps to Devices
    // in the Create a container (https://docs.docker.com/engine/api/v1.23/#create-a-container)
    // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.23/)
    // and the --device option to docker run (https://docs.docker.com/engine/reference/run/).
    Devices []*Device `locationName:"devices" type:"list"`
    // contains filtered or unexported fields
}

Linux-specific modifications that are applied to the container, such as details for device mappings.

func (LinuxParameters) GoString Uses

func (s LinuxParameters) GoString() string

GoString returns the string representation

func (*LinuxParameters) SetDevices Uses

func (s *LinuxParameters) SetDevices(v []*Device) *LinuxParameters

SetDevices sets the Devices field's value.

func (LinuxParameters) String Uses

func (s LinuxParameters) String() string

String returns the string representation

func (*LinuxParameters) Validate Uses

func (s *LinuxParameters) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListJobsInput Uses

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 job ID for a multi-node parallel job. Specifying a multi-node parallel
    // job ID with this parameter lists all nodes that are associated with the specified
    // job.
    MultiNodeJobId *string `locationName:"multiNodeJobId" type:"string"`

    // 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 Uses

func (s ListJobsInput) GoString() string

GoString returns the string representation

func (*ListJobsInput) SetArrayJobId Uses

func (s *ListJobsInput) SetArrayJobId(v string) *ListJobsInput

SetArrayJobId sets the ArrayJobId field's value.

func (*ListJobsInput) SetJobQueue Uses

func (s *ListJobsInput) SetJobQueue(v string) *ListJobsInput

SetJobQueue sets the JobQueue field's value.

func (*ListJobsInput) SetJobStatus Uses

func (s *ListJobsInput) SetJobStatus(v string) *ListJobsInput

SetJobStatus sets the JobStatus field's value.

func (*ListJobsInput) SetMaxResults Uses

func (s *ListJobsInput) SetMaxResults(v int64) *ListJobsInput

SetMaxResults sets the MaxResults field's value.

func (*ListJobsInput) SetMultiNodeJobId Uses

func (s *ListJobsInput) SetMultiNodeJobId(v string) *ListJobsInput

SetMultiNodeJobId sets the MultiNodeJobId field's value.

func (*ListJobsInput) SetNextToken Uses

func (s *ListJobsInput) SetNextToken(v string) *ListJobsInput

SetNextToken sets the NextToken field's value.

func (ListJobsInput) String Uses

func (s ListJobsInput) String() string

String returns the string representation

type ListJobsOutput Uses

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 Uses

func (s ListJobsOutput) GoString() string

GoString returns the string representation

func (*ListJobsOutput) SetJobSummaryList Uses

func (s *ListJobsOutput) SetJobSummaryList(v []*JobSummary) *ListJobsOutput

SetJobSummaryList sets the JobSummaryList field's value.

func (*ListJobsOutput) SetNextToken Uses

func (s *ListJobsOutput) SetNextToken(v string) *ListJobsOutput

SetNextToken sets the NextToken field's value.

func (ListJobsOutput) String Uses

func (s ListJobsOutput) String() string

String returns the string representation

type MountPoint Uses

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. This parameter maps to Volumes in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.19/#create-a-container) section of the Docker Remote API and the --volume option to docker run.

func (MountPoint) GoString Uses

func (s MountPoint) GoString() string

GoString returns the string representation

func (*MountPoint) SetContainerPath Uses

func (s *MountPoint) SetContainerPath(v string) *MountPoint

SetContainerPath sets the ContainerPath field's value.

func (*MountPoint) SetReadOnly Uses

func (s *MountPoint) SetReadOnly(v bool) *MountPoint

SetReadOnly sets the ReadOnly field's value.

func (*MountPoint) SetSourceVolume Uses

func (s *MountPoint) SetSourceVolume(v string) *MountPoint

SetSourceVolume sets the SourceVolume field's value.

func (MountPoint) String Uses

func (s MountPoint) String() string

String returns the string representation

type NetworkInterface Uses

type NetworkInterface struct {

    // The attachment ID for the network interface.
    AttachmentId *string `locationName:"attachmentId" type:"string"`

    // The private IPv6 address for the network interface.
    Ipv6Address *string `locationName:"ipv6Address" type:"string"`

    // The private IPv4 address for the network interface.
    PrivateIpv4Address *string `locationName:"privateIpv4Address" type:"string"`
    // contains filtered or unexported fields
}

An object representing the elastic network interface for a multi-node parallel job node.

func (NetworkInterface) GoString Uses

func (s NetworkInterface) GoString() string

GoString returns the string representation

func (*NetworkInterface) SetAttachmentId Uses

func (s *NetworkInterface) SetAttachmentId(v string) *NetworkInterface

SetAttachmentId sets the AttachmentId field's value.

func (*NetworkInterface) SetIpv6Address Uses

func (s *NetworkInterface) SetIpv6Address(v string) *NetworkInterface

SetIpv6Address sets the Ipv6Address field's value.

func (*NetworkInterface) SetPrivateIpv4Address Uses

func (s *NetworkInterface) SetPrivateIpv4Address(v string) *NetworkInterface

SetPrivateIpv4Address sets the PrivateIpv4Address field's value.

func (NetworkInterface) String Uses

func (s NetworkInterface) String() string

String returns the string representation

type NodeDetails Uses

type NodeDetails struct {

    // Specifies whether the current node is the main node for a multi-node parallel
    // job.
    IsMainNode *bool `locationName:"isMainNode" type:"boolean"`

    // The node index for the node. Node index numbering begins at zero. This index
    // is also available on the node with the AWS_BATCH_JOB_NODE_INDEX environment
    // variable.
    NodeIndex *int64 `locationName:"nodeIndex" type:"integer"`
    // contains filtered or unexported fields
}

An object representing the details of a multi-node parallel job node.

func (NodeDetails) GoString Uses

func (s NodeDetails) GoString() string

GoString returns the string representation

func (*NodeDetails) SetIsMainNode Uses

func (s *NodeDetails) SetIsMainNode(v bool) *NodeDetails

SetIsMainNode sets the IsMainNode field's value.

func (*NodeDetails) SetNodeIndex Uses

func (s *NodeDetails) SetNodeIndex(v int64) *NodeDetails

SetNodeIndex sets the NodeIndex field's value.

func (NodeDetails) String Uses

func (s NodeDetails) String() string

String returns the string representation

type NodeOverrides Uses

type NodeOverrides struct {

    // The node property overrides for the job.
    NodePropertyOverrides []*NodePropertyOverride `locationName:"nodePropertyOverrides" type:"list"`

    // The number of nodes to use with a multi-node parallel job. This value overrides
    // the number of nodes that are specified in the job definition. To use this
    // override:
    //
    //    * There must be at least one node range in your job definition that has
    //    an open upper boundary (such as : or n:).
    //
    //    * The lower boundary of the node range specified in the job definition
    //    must be fewer than the number of nodes specified in the override.
    //
    //    * The main node index specified in the job definition must be fewer than
    //    the number of nodes specified in the override.
    NumNodes *int64 `locationName:"numNodes" type:"integer"`
    // contains filtered or unexported fields
}

Object representing any node overrides to a job definition that is used in a SubmitJob API operation.

func (NodeOverrides) GoString Uses

func (s NodeOverrides) GoString() string

GoString returns the string representation

func (*NodeOverrides) SetNodePropertyOverrides Uses

func (s *NodeOverrides) SetNodePropertyOverrides(v []*NodePropertyOverride) *NodeOverrides

SetNodePropertyOverrides sets the NodePropertyOverrides field's value.

func (*NodeOverrides) SetNumNodes Uses

func (s *NodeOverrides) SetNumNodes(v int64) *NodeOverrides

SetNumNodes sets the NumNodes field's value.

func (NodeOverrides) String Uses

func (s NodeOverrides) String() string

String returns the string representation

func (*NodeOverrides) Validate Uses

func (s *NodeOverrides) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type NodeProperties Uses

type NodeProperties struct {

    // Specifies the node index for the main node of a multi-node parallel job.
    // This node index value must be fewer than the number of nodes.
    //
    // MainNode is a required field
    MainNode *int64 `locationName:"mainNode" type:"integer" required:"true"`

    // A list of node ranges and their properties associated with a multi-node parallel
    // job.
    //
    // NodeRangeProperties is a required field
    NodeRangeProperties []*NodeRangeProperty `locationName:"nodeRangeProperties" type:"list" required:"true"`

    // The number of nodes associated with a multi-node parallel job.
    //
    // NumNodes is a required field
    NumNodes *int64 `locationName:"numNodes" type:"integer" required:"true"`
    // contains filtered or unexported fields
}

An object representing the node properties of a multi-node parallel job.

func (NodeProperties) GoString Uses

func (s NodeProperties) GoString() string

GoString returns the string representation

func (*NodeProperties) SetMainNode Uses

func (s *NodeProperties) SetMainNode(v int64) *NodeProperties

SetMainNode sets the MainNode field's value.

func (*NodeProperties) SetNodeRangeProperties Uses

func (s *NodeProperties) SetNodeRangeProperties(v []*NodeRangeProperty) *NodeProperties

SetNodeRangeProperties sets the NodeRangeProperties field's value.

func (*NodeProperties) SetNumNodes Uses

func (s *NodeProperties) SetNumNodes(v int64) *NodeProperties

SetNumNodes sets the NumNodes field's value.

func (NodeProperties) String Uses

func (s NodeProperties) String() string

String returns the string representation

func (*NodeProperties) Validate Uses

func (s *NodeProperties) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type NodePropertiesSummary Uses

type NodePropertiesSummary struct {

    // Specifies whether the current node is the main node for a multi-node parallel
    // job.
    IsMainNode *bool `locationName:"isMainNode" type:"boolean"`

    // The node index for the node. Node index numbering begins at zero. This index
    // is also available on the node with the AWS_BATCH_JOB_NODE_INDEX environment
    // variable.
    NodeIndex *int64 `locationName:"nodeIndex" type:"integer"`

    // The number of nodes associated with a multi-node parallel job.
    NumNodes *int64 `locationName:"numNodes" type:"integer"`
    // contains filtered or unexported fields
}

An object representing the properties of a node that is associated with a multi-node parallel job.

func (NodePropertiesSummary) GoString Uses

func (s NodePropertiesSummary) GoString() string

GoString returns the string representation

func (*NodePropertiesSummary) SetIsMainNode Uses

func (s *NodePropertiesSummary) SetIsMainNode(v bool) *NodePropertiesSummary

SetIsMainNode sets the IsMainNode field's value.

func (*NodePropertiesSummary) SetNodeIndex Uses

func (s *NodePropertiesSummary) SetNodeIndex(v int64) *NodePropertiesSummary

SetNodeIndex sets the NodeIndex field's value.

func (*NodePropertiesSummary) SetNumNodes Uses

func (s *NodePropertiesSummary) SetNumNodes(v int64) *NodePropertiesSummary

SetNumNodes sets the NumNodes field's value.

func (NodePropertiesSummary) String Uses

func (s NodePropertiesSummary) String() string

String returns the string representation

type NodePropertyOverride Uses

type NodePropertyOverride struct {

    // The overrides that should be sent to a node range.
    ContainerOverrides *ContainerOverrides `locationName:"containerOverrides" type:"structure"`

    // The range of nodes, using node index values, with which to override. A range
    // of 0:3 indicates nodes with index values of 0 through 3. If the starting
    // range value is omitted (:n), then 0 is used to start the range. If the ending
    // range value is omitted (n:), then the highest possible node index is used
    // to end the range.
    //
    // TargetNodes is a required field
    TargetNodes *string `locationName:"targetNodes" type:"string" required:"true"`
    // contains filtered or unexported fields
}

Object representing any node overrides to a job definition that is used in a SubmitJob API operation.

func (NodePropertyOverride) GoString Uses

func (s NodePropertyOverride) GoString() string

GoString returns the string representation

func (*NodePropertyOverride) SetContainerOverrides Uses

func (s *NodePropertyOverride) SetContainerOverrides(v *ContainerOverrides) *NodePropertyOverride

SetContainerOverrides sets the ContainerOverrides field's value.

func (*NodePropertyOverride) SetTargetNodes Uses

func (s *NodePropertyOverride) SetTargetNodes(v string) *NodePropertyOverride

SetTargetNodes sets the TargetNodes field's value.

func (NodePropertyOverride) String Uses

func (s NodePropertyOverride) String() string

String returns the string representation

func (*NodePropertyOverride) Validate Uses

func (s *NodePropertyOverride) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type NodeRangeProperty Uses

type NodeRangeProperty struct {

    // The container details for the node range.
    Container *ContainerProperties `locationName:"container" type:"structure"`

    // The range of nodes, using node index values. A range of 0:3 indicates nodes
    // with index values of 0 through 3. If the starting range value is omitted
    // (:n), then 0 is used to start the range. If the ending range value is omitted
    // (n:), then the highest possible node index is used to end the range. Your
    // accumulative node ranges must account for all nodes (0:n). You may nest node
    // ranges, for example 0:10 and 4:5, in which case the 4:5 range properties
    // override the 0:10 properties.
    //
    // TargetNodes is a required field
    TargetNodes *string `locationName:"targetNodes" type:"string" required:"true"`
    // contains filtered or unexported fields
}

An object representing the properties of the node range for a multi-node parallel job.

func (NodeRangeProperty) GoString Uses

func (s NodeRangeProperty) GoString() string

GoString returns the string representation

func (*NodeRangeProperty) SetContainer Uses

func (s *NodeRangeProperty) SetContainer(v *ContainerProperties) *NodeRangeProperty

SetContainer sets the Container field's value.

func (*NodeRangeProperty) SetTargetNodes Uses

func (s *NodeRangeProperty) SetTargetNodes(v string) *NodeRangeProperty

SetTargetNodes sets the TargetNodes field's value.

func (NodeRangeProperty) String Uses

func (s NodeRangeProperty) String() string

String returns the string representation

func (*NodeRangeProperty) Validate Uses

func (s *NodeRangeProperty) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RegisterJobDefinitionInput Uses

type RegisterJobDefinitionInput struct {

    // An object with various properties specific to single-node container-based
    // jobs. If the job definition's type parameter is container, then you must
    // specify either containerProperties or nodeProperties.
    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"`

    // An object with various properties specific to multi-node parallel jobs. If
    // you specify node properties for a job, it becomes a multi-node parallel job.
    // For more information, see Multi-node Parallel Jobs (https://docs.aws.amazon.com/batch/latest/userguide/multi-node-parallel-jobs.html)
    // in the AWS Batch User Guide. If the job definition's type parameter is container,
    // then you must specify either containerProperties or nodeProperties.
    NodeProperties *NodeProperties `locationName:"nodeProperties" type:"structure"`

    // 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 (https://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 Uses

func (s RegisterJobDefinitionInput) GoString() string

GoString returns the string representation

func (*RegisterJobDefinitionInput) SetContainerProperties Uses

func (s *RegisterJobDefinitionInput) SetContainerProperties(v *ContainerProperties) *RegisterJobDefinitionInput

SetContainerProperties sets the ContainerProperties field's value.

func (*RegisterJobDefinitionInput) SetJobDefinitionName Uses

func (s *RegisterJobDefinitionInput) SetJobDefinitionName(v string) *RegisterJobDefinitionInput

SetJobDefinitionName sets the JobDefinitionName field's value.

func (*RegisterJobDefinitionInput) SetNodeProperties Uses

func (s *RegisterJobDefinitionInput) SetNodeProperties(v *NodeProperties) *RegisterJobDefinitionInput

SetNodeProperties sets the NodeProperties field's value.

func (*RegisterJobDefinitionInput) SetParameters Uses

func (s *RegisterJobDefinitionInput) SetParameters(v map[string]*string) *RegisterJobDefinitionInput

SetParameters sets the Parameters field's value.

func (*RegisterJobDefinitionInput) SetRetryStrategy Uses

func (s *RegisterJobDefinitionInput) SetRetryStrategy(v *RetryStrategy) *RegisterJobDefinitionInput

SetRetryStrategy sets the RetryStrategy field's value.

func (*RegisterJobDefinitionInput) SetTimeout Uses

func (s *RegisterJobDefinitionInput) SetTimeout(v *JobTimeout) *RegisterJobDefinitionInput

SetTimeout sets the Timeout field's value.

func (*RegisterJobDefinitionInput) SetType Uses

func (s *RegisterJobDefinitionInput) SetType(v string) *RegisterJobDefinitionInput

SetType sets the Type field's value.

func (RegisterJobDefinitionInput) String Uses

func (s RegisterJobDefinitionInput) String() string

String returns the string representation

func (*RegisterJobDefinitionInput) Validate Uses

func (s *RegisterJobDefinitionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RegisterJobDefinitionOutput Uses

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 Uses

func (s RegisterJobDefinitionOutput) GoString() string

GoString returns the string representation

func (*RegisterJobDefinitionOutput) SetJobDefinitionArn Uses

func (s *RegisterJobDefinitionOutput) SetJobDefinitionArn(v string) *RegisterJobDefinitionOutput

SetJobDefinitionArn sets the JobDefinitionArn field's value.

func (*RegisterJobDefinitionOutput) SetJobDefinitionName Uses

func (s *RegisterJobDefinitionOutput) SetJobDefinitionName(v string) *RegisterJobDefinitionOutput

SetJobDefinitionName sets the JobDefinitionName field's value.

func (*RegisterJobDefinitionOutput) SetRevision Uses

func (s *RegisterJobDefinitionOutput) SetRevision(v int64) *RegisterJobDefinitionOutput

SetRevision sets the Revision field's value.

func (RegisterJobDefinitionOutput) String Uses

func (s RegisterJobDefinitionOutput) String() string

String returns the string representation

type ResourceRequirement Uses

type ResourceRequirement struct {

    // The type of resource to assign to a container. Currently, the only supported
    // resource type is GPU.
    //
    // Type is a required field
    Type *string `locationName:"type" type:"string" required:"true" enum:"ResourceType"`

    // The number of physical GPUs to reserve for the container. The number of GPUs
    // reserved for all containers in a job should not exceed the number of available
    // GPUs on the compute resource that the job is launched on.
    //
    // Value is a required field
    Value *string `locationName:"value" type:"string" required:"true"`
    // contains filtered or unexported fields
}

The type and amount of a resource to assign to a container. Currently, the only supported resource type is GPU.

func (ResourceRequirement) GoString Uses

func (s ResourceRequirement) GoString() string

GoString returns the string representation

func (*ResourceRequirement) SetType Uses

func (s *ResourceRequirement) SetType(v string) *ResourceRequirement

SetType sets the Type field's value.

func (*ResourceRequirement) SetValue Uses

func (s *ResourceRequirement) SetValue(v string) *ResourceRequirement

SetValue sets the Value field's value.

func (ResourceRequirement) String Uses

func (s ResourceRequirement) String() string

String returns the string representation

func (*ResourceRequirement) Validate Uses

func (s *ResourceRequirement) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RetryStrategy Uses

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 on failure the same number of attempts as the value.
    Attempts *int64 `locationName:"attempts" type:"integer"`
    // contains filtered or unexported fields
}

The retry strategy associated with a job.

func (RetryStrategy) GoString Uses

func (s RetryStrategy) GoString() string

GoString returns the string representation

func (*RetryStrategy) SetAttempts Uses

func (s *RetryStrategy) SetAttempts(v int64) *RetryStrategy

SetAttempts sets the Attempts field's value.

func (RetryStrategy) String Uses

func (s RetryStrategy) String() string

String returns the string representation

type SubmitJobInput Uses

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
    // (https://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. In that case, 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"`

    // A list of node overrides in JSON format that specify the node range to target
    // and the container overrides for that node range.
    NodeOverrides *NodeOverrides `locationName:"nodeOverrides" type:"structure"`

    // 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 (https://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 Uses

func (s SubmitJobInput) GoString() string

GoString returns the string representation

func (*SubmitJobInput) SetArrayProperties Uses

func (s *SubmitJobInput) SetArrayProperties(v *ArrayProperties) *SubmitJobInput

SetArrayProperties sets the ArrayProperties field's value.

func (*SubmitJobInput) SetContainerOverrides Uses

func (s *SubmitJobInput) SetContainerOverrides(v *ContainerOverrides) *SubmitJobInput

SetContainerOverrides sets the ContainerOverrides field's value.

func (*SubmitJobInput) SetDependsOn Uses

func (s *SubmitJobInput) SetDependsOn(v []*JobDependency) *SubmitJobInput

SetDependsOn sets the DependsOn field's value.

func (*SubmitJobInput) SetJobDefinition Uses

func (s *SubmitJobInput) SetJobDefinition(v string) *SubmitJobInput

SetJobDefinition sets the JobDefinition field's value.

func (*SubmitJobInput) SetJobName Uses

func (s *SubmitJobInput) SetJobName(v string) *SubmitJobInput

SetJobName sets the JobName field's value.

func (*SubmitJobInput) SetJobQueue Uses

func (s *SubmitJobInput) SetJobQueue(v string) *SubmitJobInput

SetJobQueue sets the JobQueue field's value.

func (*SubmitJobInput) SetNodeOverrides Uses

func (s *SubmitJobInput) SetNodeOverrides(v *NodeOverrides) *SubmitJobInput

SetNodeOverrides sets the NodeOverrides field's value.

func (*SubmitJobInput) SetParameters Uses

func (s *SubmitJobInput) SetParameters(v map[string]*string) *SubmitJobInput

SetParameters sets the Parameters field's value.

func (*SubmitJobInput) SetRetryStrategy Uses

func (s *SubmitJobInput) SetRetryStrategy(v *RetryStrategy) *SubmitJobInput

SetRetryStrategy sets the RetryStrategy field's value.

func (*SubmitJobInput) SetTimeout Uses

func (s *SubmitJobInput) SetTimeout(v *JobTimeout) *SubmitJobInput

SetTimeout sets the Timeout field's value.

func (SubmitJobInput) String Uses

func (s SubmitJobInput) String() string

String returns the string representation

func (*SubmitJobInput) Validate Uses

func (s *SubmitJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SubmitJobOutput Uses

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 Uses

func (s SubmitJobOutput) GoString() string

GoString returns the string representation

func (*SubmitJobOutput) SetJobId Uses

func (s *SubmitJobOutput) SetJobId(v string) *SubmitJobOutput

SetJobId sets the JobId field's value.

func (*SubmitJobOutput) SetJobName Uses

func (s *SubmitJobOutput) SetJobName(v string) *SubmitJobOutput

SetJobName sets the JobName field's value.

func (SubmitJobOutput) String Uses

func (s SubmitJobOutput) String() string

String returns the string representation

type TerminateJobInput Uses

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 Uses

func (s TerminateJobInput) GoString() string

GoString returns the string representation

func (*TerminateJobInput) SetJobId Uses

func (s *TerminateJobInput) SetJobId(v string) *TerminateJobInput

SetJobId sets the JobId field's value.

func (*TerminateJobInput) SetReason Uses

func (s *TerminateJobInput) SetReason(v string) *TerminateJobInput

SetReason sets the Reason field's value.

func (TerminateJobInput) String Uses

func (s TerminateJobInput) String() string

String returns the string representation

func (*TerminateJobInput) Validate Uses

func (s *TerminateJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TerminateJobOutput Uses

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

func (TerminateJobOutput) GoString Uses

func (s TerminateJobOutput) GoString() string

GoString returns the string representation

func (TerminateJobOutput) String Uses

func (s TerminateJobOutput) String() string

String returns the string representation

type Ulimit Uses

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) GoString Uses

func (s Ulimit) GoString() string

GoString returns the string representation

func (*Ulimit) SetHardLimit Uses

func (s *Ulimit) SetHardLimit(v int64) *Ulimit

SetHardLimit sets the HardLimit field's value.

func (*Ulimit) SetName Uses

func (s *Ulimit) SetName(v string) *Ulimit

SetName sets the Name field's value.

func (*Ulimit) SetSoftLimit Uses

func (s *Ulimit) SetSoftLimit(v int64) *Ulimit

SetSoftLimit sets the SoftLimit field's value.

func (Ulimit) String Uses

func (s Ulimit) String() string

String returns the string representation

func (*Ulimit) Validate Uses

func (s *Ulimit) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateComputeEnvironmentInput Uses

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 Uses

func (s UpdateComputeEnvironmentInput) GoString() string

GoString returns the string representation

func (*UpdateComputeEnvironmentInput) SetComputeEnvironment Uses

func (s *UpdateComputeEnvironmentInput) SetComputeEnvironment(v string) *UpdateComputeEnvironmentInput

SetComputeEnvironment sets the ComputeEnvironment field's value.

func (*UpdateComputeEnvironmentInput) SetComputeResources Uses

func (s *UpdateComputeEnvironmentInput) SetComputeResources(v *ComputeResourceUpdate) *UpdateComputeEnvironmentInput

SetComputeResources sets the ComputeResources field's value.

func (*UpdateComputeEnvironmentInput) SetServiceRole Uses

func (s *UpdateComputeEnvironmentInput) SetServiceRole(v string) *UpdateComputeEnvironmentInput

SetServiceRole sets the ServiceRole field's value.

func (*UpdateComputeEnvironmentInput) SetState Uses

func (s *UpdateComputeEnvironmentInput) SetState(v string) *UpdateComputeEnvironmentInput

SetState sets the State field's value.

func (UpdateComputeEnvironmentInput) String Uses

func (s UpdateComputeEnvironmentInput) String() string

String returns the string representation

func (*UpdateComputeEnvironmentInput) Validate Uses

func (s *UpdateComputeEnvironmentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateComputeEnvironmentOutput Uses

type UpdateComputeEnvironmentOutput 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 (UpdateComputeEnvironmentOutput) GoString Uses

func (s UpdateComputeEnvironmentOutput) GoString() string

GoString returns the string representation

func (*UpdateComputeEnvironmentOutput) SetComputeEnvironmentArn Uses

func (s *UpdateComputeEnvironmentOutput) SetComputeEnvironmentArn(v string) *UpdateComputeEnvironmentOutput

SetComputeEnvironmentArn sets the ComputeEnvironmentArn field's value.

func (*UpdateComputeEnvironmentOutput) SetComputeEnvironmentName Uses

func (s *UpdateComputeEnvironmentOutput) SetComputeEnvironmentName(v string) *UpdateComputeEnvironmentOutput

SetComputeEnvironmentName sets the ComputeEnvironmentName field's value.

func (UpdateComputeEnvironmentOutput) String Uses

func (s UpdateComputeEnvironmentOutput) String() string

String returns the string representation

type UpdateJobQueueInput Uses

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 the 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 Uses

func (s UpdateJobQueueInput) GoString() string

GoString returns the string representation

func (*UpdateJobQueueInput) SetComputeEnvironmentOrder Uses

func (s *UpdateJobQueueInput) SetComputeEnvironmentOrder(v []*ComputeEnvironmentOrder) *UpdateJobQueueInput

SetComputeEnvironmentOrder sets the ComputeEnvironmentOrder field's value.

func (*UpdateJobQueueInput) SetJobQueue Uses

func (s *UpdateJobQueueInput) SetJobQueue(v string) *UpdateJobQueueInput

SetJobQueue sets the JobQueue field's value.

func (*UpdateJobQueueInput) SetPriority Uses

func (s *UpdateJobQueueInput) SetPriority(v int64) *UpdateJobQueueInput

SetPriority sets the Priority field's value.

func (*UpdateJobQueueInput) SetState Uses

func (s *UpdateJobQueueInput) SetState(v string) *UpdateJobQueueInput

SetState sets the State field's value.

func (UpdateJobQueueInput) String Uses

func (s UpdateJobQueueInput) String() string

String returns the string representation

func (*UpdateJobQueueInput) Validate Uses

func (s *UpdateJobQueueInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateJobQueueOutput Uses

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 Uses

func (s UpdateJobQueueOutput) GoString() string

GoString returns the string representation

func (*UpdateJobQueueOutput) SetJobQueueArn Uses

func (s *UpdateJobQueueOutput) SetJobQueueArn(v string) *UpdateJobQueueOutput

SetJobQueueArn sets the JobQueueArn field's value.

func (*UpdateJobQueueOutput) SetJobQueueName Uses

func (s *UpdateJobQueueOutput) SetJobQueueName(v string) *UpdateJobQueueOutput

SetJobQueueName sets the JobQueueName field's value.

func (UpdateJobQueueOutput) String Uses

func (s UpdateJobQueueOutput) String() string

String returns the string representation

type Volume Uses

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.

func (Volume) GoString Uses

func (s Volume) GoString() string

GoString returns the string representation

func (*Volume) SetHost Uses

func (s *Volume) SetHost(v *Host) *Volume

SetHost sets the Host field's value.

func (*Volume) SetName Uses

func (s *Volume) SetName(v string) *Volume

SetName sets the Name field's value.

func (Volume) String Uses

func (s Volume) String() string

String returns the string representation

Directories

PathSynopsis
batchifacePackage batchiface provides an interface to enable mocking the AWS Batch service client for testing your code.

Package batch imports 9 packages (graph) and is imported by 26 packages. Updated 2019-08-06. Refresh now. Tools for package owners.