Documentation

Overview

    Package batch provides the API client, operations, and parameter types for AWS Batch.

    Using AWS Batch, you can run batch computing workloads on the AWS Cloud. Batch computing is a common means for developers, scientists, and engineers to access large amounts of compute resources. AWS Batch uses the advantages of this computing workload to remove the undifferentiated heavy lifting of configuring and managing required infrastructure. At the same time, it also adopts a familiar batch computing software approach. Given these advantages, AWS Batch can help you to efficiently provision resources in response to jobs submitted, thus effectively helping you to eliminate capacity constraints, reduce compute costs, and deliver your results more quickly. As a fully managed service, AWS Batch can run batch computing workloads of any scale. AWS Batch automatically provisions compute resources and optimizes workload distribution based on the quantity and scale of your specific workloads. With AWS Batch, there's no need to install or manage batch computing software. This means that you can focus your time and energy on analyzing results and solving your specific problems.

    Index

    Constants

    View Source
    const ServiceAPIVersion = "2016-08-10"
    View Source
    const ServiceID = "Batch"

    Variables

    This section is empty.

    Functions

    func NewDefaultEndpointResolver

    func NewDefaultEndpointResolver() *internalendpoints.Resolver

      NewDefaultEndpointResolver constructs a new service endpoint resolver

      func WithAPIOptions

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

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

        func WithEndpointResolver

        func WithEndpointResolver(v EndpointResolver) func(*Options)

          WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

          Types

          type CancelJobInput

          type CancelJobInput struct {
          
          	// The AWS Batch job ID of the job to cancel.
          	//
          	// This member is required.
          	JobId *string
          
          	// 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.
          	//
          	// This member is required.
          	Reason *string
          }

            Contains the parameters for CancelJob.

            type CancelJobOutput

            type CancelJobOutput struct {
            	// Metadata pertaining to the operation's result.
            	ResultMetadata middleware.Metadata
            }

            type Client

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

              Client provides the API client to make operations call for AWS Batch.

              func New

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

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

                func NewFromConfig

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

                  NewFromConfig returns a new client from the provided config.

                  func (*Client) CancelJob

                  func (c *Client) CancelJob(ctx context.Context, params *CancelJobInput, optFns ...func(*Options)) (*CancelJobOutput, error)

                    Cancels a job in an AWS Batch job queue. Jobs that are in the SUBMITTED, PENDING, or RUNNABLE state are canceled. Jobs that have progressed to STARTING or RUNNING aren't canceled, but the API operation still succeeds, even if no job is canceled. These jobs must be terminated with the TerminateJob operation.

                    func (*Client) CreateComputeEnvironment

                    func (c *Client) CreateComputeEnvironment(ctx context.Context, params *CreateComputeEnvironmentInput, optFns ...func(*Options)) (*CreateComputeEnvironmentOutput, error)

                      Creates an AWS Batch compute environment. You can create MANAGED or UNMANAGED compute environments. MANAGED compute environments can use Amazon EC2 or AWS Fargate resources. UNMANAGED compute environments can only use EC2 resources. 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. Either, you can choose to use EC2 On-Demand Instances and EC2 Spot Instances. Or, you can use Fargate and Fargate Spot capacity in your managed compute environment. You can optionally set a maximum price so that Spot Instances only launch when the Spot Instance price is less than a specified percentage of the On-Demand price. Multi-node parallel jobs aren't supported on Spot Instances. In an unmanaged compute environment, you can manage your own EC2 compute resources and have a lot of flexibility with how you configure your compute resources. For example, you can use custom AMIs. However, you must verify that each of your AMIs meet 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 created your unmanaged compute environment, you can use the DescribeComputeEnvironments operation to find the Amazon ECS cluster that's associated with it. Then, 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 doesn't upgrade the AMIs in a compute environment after the environment is created. For example, it doesn't update the AMIs when a newer version of the Amazon ECS optimized AMI is available. Therefore, you're responsible for managing the guest operating system (including its 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, complete these steps:

                      * Create a new compute environment with the new AMI.

                      * Add the compute environment to an existing job queue.

                      * Remove the earlier compute environment from your job queue.

                      * Delete the earlier compute environment.

                      func (*Client) CreateJobQueue

                      func (c *Client) CreateJobQueue(ctx context.Context, params *CreateJobQueueInput, optFns ...func(*Options)) (*CreateJobQueueOutput, error)

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

                        func (*Client) DeleteComputeEnvironment

                        func (c *Client) DeleteComputeEnvironment(ctx context.Context, params *DeleteComputeEnvironmentInput, optFns ...func(*Options)) (*DeleteComputeEnvironmentOutput, error)

                          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. Compute environments that use AWS Fargate resources must terminate all active jobs on that compute environment before deleting the compute environment. If this isn't done, the compute environment enters an invalid state.

                          func (*Client) DeleteJobQueue

                          func (c *Client) DeleteJobQueue(ctx context.Context, params *DeleteJobQueueInput, optFns ...func(*Options)) (*DeleteJobQueueOutput, error)

                            Deletes the specified job queue. You must first disable submissions for a queue with the UpdateJobQueue operation. All jobs in the queue are eventually terminated when you delete a job queue. The jobs are terminated at a rate of about 16 jobs each second. It's not necessary to disassociate compute environments from a queue before submitting a DeleteJobQueue request.

                            func (*Client) DeregisterJobDefinition

                            func (c *Client) DeregisterJobDefinition(ctx context.Context, params *DeregisterJobDefinitionInput, optFns ...func(*Options)) (*DeregisterJobDefinitionOutput, error)

                              Deregisters an AWS Batch job definition. Job definitions are permanently deleted after 180 days.

                              func (*Client) DescribeComputeEnvironments

                              func (c *Client) DescribeComputeEnvironments(ctx context.Context, params *DescribeComputeEnvironmentsInput, optFns ...func(*Options)) (*DescribeComputeEnvironmentsOutput, error)

                                Describes one or more of your compute environments. If you're 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.

                                func (*Client) DescribeJobDefinitions

                                func (c *Client) DescribeJobDefinitions(ctx context.Context, params *DescribeJobDefinitionsInput, optFns ...func(*Options)) (*DescribeJobDefinitionsOutput, error)

                                  Describes a list of job definitions. You can specify a status (such as ACTIVE) to only return job definitions that match that status.

                                  func (*Client) DescribeJobQueues

                                  func (c *Client) DescribeJobQueues(ctx context.Context, params *DescribeJobQueuesInput, optFns ...func(*Options)) (*DescribeJobQueuesOutput, error)

                                    Describes one or more of your job queues.

                                    func (*Client) DescribeJobs

                                    func (c *Client) DescribeJobs(ctx context.Context, params *DescribeJobsInput, optFns ...func(*Options)) (*DescribeJobsOutput, error)

                                      Describes a list of AWS Batch jobs.

                                      func (*Client) ListJobs

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

                                        Returns a list of AWS Batch jobs. You must specify only one of the following items:

                                        * 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 nodes for that job

                                        * An array job ID to return a list of the children for that job

                                        You can filter the results by job status with the jobStatus parameter. If you don't specify a status, only RUNNING jobs are returned.

                                        func (*Client) ListTagsForResource

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

                                          Lists the tags for an AWS Batch resource. AWS Batch resources that support tags are compute environments, jobs, job definitions, and job queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.

                                          func (*Client) RegisterJobDefinition

                                          func (c *Client) RegisterJobDefinition(ctx context.Context, params *RegisterJobDefinitionInput, optFns ...func(*Options)) (*RegisterJobDefinitionOutput, error)

                                            Registers an AWS Batch job definition.

                                            func (*Client) SubmitJob

                                            func (c *Client) SubmitJob(ctx context.Context, params *SubmitJobInput, optFns ...func(*Options)) (*SubmitJobOutput, error)

                                              Submits an AWS Batch job from a job definition. Parameters that are specified during SubmitJob override parameters defined in the job definition. vCPU and memory requirements that are specified in the ResourceRequirements objects in the job definition are the exception. They can't be overridden this way using the memory and vcpus parameters. Rather, you must specify updates to job definition parameters in a ResourceRequirements object that's included in the containerOverrides parameter. Jobs that run on Fargate resources can't be guaranteed to run for more than 14 days. This is because, after 14 days, Fargate resources might become unavailable and job might be terminated.

                                              func (*Client) TagResource

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

                                                Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags associated with that resource are deleted as well. AWS Batch resources that support tags are compute environments, jobs, job definitions, and job queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.

                                                func (*Client) TerminateJob

                                                func (c *Client) TerminateJob(ctx context.Context, params *TerminateJobInput, optFns ...func(*Options)) (*TerminateJobOutput, error)

                                                  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.

                                                  func (*Client) UntagResource

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

                                                    Deletes specified tags from an AWS Batch resource.

                                                    func (*Client) UpdateComputeEnvironment

                                                    func (c *Client) UpdateComputeEnvironment(ctx context.Context, params *UpdateComputeEnvironmentInput, optFns ...func(*Options)) (*UpdateComputeEnvironmentOutput, error)

                                                      Updates an AWS Batch compute environment.

                                                      func (*Client) UpdateJobQueue

                                                      func (c *Client) UpdateJobQueue(ctx context.Context, params *UpdateJobQueueInput, optFns ...func(*Options)) (*UpdateJobQueueOutput, error)

                                                        Updates a job queue.

                                                        type CreateComputeEnvironmentInput

                                                        type CreateComputeEnvironmentInput struct {
                                                        
                                                        	// The name for your compute environment. Up to 128 letters (uppercase and
                                                        	// lowercase), numbers, hyphens, and underscores are allowed.
                                                        	//
                                                        	// This member is required.
                                                        	ComputeEnvironmentName *string
                                                        
                                                        	// The type of the compute environment: MANAGED or UNMANAGED. For more information,
                                                        	// see Compute Environments
                                                        	// (https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html)
                                                        	// in the AWS Batch User Guide.
                                                        	//
                                                        	// This member is required.
                                                        	Type types.CEType
                                                        
                                                        	// Details about 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 *types.ComputeResource
                                                        
                                                        	// The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to
                                                        	// make calls to other AWS services on your behalf. For more information, see AWS
                                                        	// Batch service IAM role
                                                        	// (https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html) in
                                                        	// the AWS Batch User Guide. If your account has already created the AWS Batch
                                                        	// service-linked role, that role is used by default for your compute environment
                                                        	// unless you specify a role here. If the AWS Batch service-linked role does not
                                                        	// exist in your account, and no role is specified here, the service will try to
                                                        	// create the AWS Batch service-linked role in your account. If your specified role
                                                        	// has a path other than /, then you must specify either the full role ARN
                                                        	// (recommended) or prefix the role name with the path. For example, if a role with
                                                        	// the name bar has a path of /foo/ then you would specify /foo/bar as the role
                                                        	// name. For more information, see Friendly names and paths
                                                        	// (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names)
                                                        	// in the IAM User Guide. Depending on how you created your AWS Batch service role,
                                                        	// its ARN might contain the service-role path prefix. When you only specify the
                                                        	// name of the service role, AWS Batch assumes that your ARN doesn't 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
                                                        
                                                        	// 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. 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 doesn't 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 don't scale out.
                                                        	// However, they scale in to minvCpus value after instances become idle.
                                                        	State types.CEState
                                                        
                                                        	// The tags that you apply to the compute environment to help you categorize and
                                                        	// organize your resources. Each tag consists of a key and an optional value. For
                                                        	// more information, see Tagging AWS Resources
                                                        	// (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in AWS General
                                                        	// Reference. These tags can be updated or removed using the TagResource
                                                        	// (https://docs.aws.amazon.com/batch/latest/APIReference/API_TagResource.html) and
                                                        	// UntagResource
                                                        	// (https://docs.aws.amazon.com/batch/latest/APIReference/API_UntagResource.html)
                                                        	// API operations. These tags don't propagate to the underlying compute resources.
                                                        	Tags map[string]string
                                                        }

                                                          Contains the parameters for CreateComputeEnvironment.

                                                          type CreateComputeEnvironmentOutput

                                                          type CreateComputeEnvironmentOutput struct {
                                                          
                                                          	// The Amazon Resource Name (ARN) of the compute environment.
                                                          	ComputeEnvironmentArn *string
                                                          
                                                          	// The name of the compute environment. Up to 128 letters (uppercase and
                                                          	// lowercase), numbers, hyphens, and underscores are allowed.
                                                          	ComputeEnvironmentName *string
                                                          
                                                          	// Metadata pertaining to the operation's result.
                                                          	ResultMetadata middleware.Metadata
                                                          }

                                                          type CreateJobQueueInput

                                                          type CreateJobQueueInput struct {
                                                          
                                                          	// The set of compute environments mapped to a job queue and their order relative
                                                          	// to each other. The job scheduler uses this parameter to determine which compute
                                                          	// environment should run a specific 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. All of the compute environments
                                                          	// must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and
                                                          	// Fargate compute environments can't be mixed. All compute environments that are
                                                          	// associated with a job queue must share the same architecture. AWS Batch doesn't
                                                          	// support mixing compute environment architecture types in a single job queue.
                                                          	//
                                                          	// This member is required.
                                                          	ComputeEnvironmentOrder []types.ComputeEnvironmentOrder
                                                          
                                                          	// The name of the job queue. Up to 128 letters (uppercase and lowercase), numbers,
                                                          	// and underscores are allowed.
                                                          	//
                                                          	// This member is required.
                                                          	JobQueueName *string
                                                          
                                                          	// 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. All of the compute
                                                          	// environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or
                                                          	// FARGATE_SPOT); EC2 and Fargate compute environments cannot be mixed.
                                                          	//
                                                          	// This member is required.
                                                          	Priority int32
                                                          
                                                          	// The state of the job queue. If the job queue state is ENABLED, it is able to
                                                          	// accept jobs. If the job queue state is DISABLED, new jobs can't be added to the
                                                          	// queue, but jobs already in the queue can finish.
                                                          	State types.JQState
                                                          
                                                          	// The tags that you apply to the job queue to help you categorize and organize
                                                          	// your resources. Each tag consists of a key and an optional value. For more
                                                          	// information, see Tagging your AWS Batch resources
                                                          	// (https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html) in AWS
                                                          	// Batch User Guide.
                                                          	Tags map[string]string
                                                          }

                                                            Contains the parameters for CreateJobQueue.

                                                            type CreateJobQueueOutput

                                                            type CreateJobQueueOutput struct {
                                                            
                                                            	// The Amazon Resource Name (ARN) of the job queue.
                                                            	//
                                                            	// This member is required.
                                                            	JobQueueArn *string
                                                            
                                                            	// The name of the job queue.
                                                            	//
                                                            	// This member is required.
                                                            	JobQueueName *string
                                                            
                                                            	// Metadata pertaining to the operation's result.
                                                            	ResultMetadata middleware.Metadata
                                                            }

                                                            type DeleteComputeEnvironmentInput

                                                            type DeleteComputeEnvironmentInput struct {
                                                            
                                                            	// The name or Amazon Resource Name (ARN) of the compute environment to delete.
                                                            	//
                                                            	// This member is required.
                                                            	ComputeEnvironment *string
                                                            }

                                                              Contains the parameters for DeleteComputeEnvironment.

                                                              type DeleteComputeEnvironmentOutput

                                                              type DeleteComputeEnvironmentOutput struct {
                                                              	// Metadata pertaining to the operation's result.
                                                              	ResultMetadata middleware.Metadata
                                                              }

                                                              type DeleteJobQueueInput

                                                              type DeleteJobQueueInput struct {
                                                              
                                                              	// The short name or full Amazon Resource Name (ARN) of the queue to delete.
                                                              	//
                                                              	// This member is required.
                                                              	JobQueue *string
                                                              }

                                                                Contains the parameters for DeleteJobQueue.

                                                                type DeleteJobQueueOutput

                                                                type DeleteJobQueueOutput struct {
                                                                	// Metadata pertaining to the operation's result.
                                                                	ResultMetadata middleware.Metadata
                                                                }

                                                                type DeregisterJobDefinitionInput

                                                                type DeregisterJobDefinitionInput struct {
                                                                
                                                                	// The name and revision (name:revision) or full Amazon Resource Name (ARN) of the
                                                                	// job definition to deregister.
                                                                	//
                                                                	// This member is required.
                                                                	JobDefinition *string
                                                                }

                                                                type DeregisterJobDefinitionOutput

                                                                type DeregisterJobDefinitionOutput struct {
                                                                	// Metadata pertaining to the operation's result.
                                                                	ResultMetadata middleware.Metadata
                                                                }

                                                                type DescribeComputeEnvironmentsAPIClient

                                                                type DescribeComputeEnvironmentsAPIClient interface {
                                                                	DescribeComputeEnvironments(context.Context, *DescribeComputeEnvironmentsInput, ...func(*Options)) (*DescribeComputeEnvironmentsOutput, error)
                                                                }

                                                                  DescribeComputeEnvironmentsAPIClient is a client that implements the DescribeComputeEnvironments operation.

                                                                  type DescribeComputeEnvironmentsInput

                                                                  type DescribeComputeEnvironmentsInput struct {
                                                                  
                                                                  	// A list of up to 100 compute environment names or full Amazon Resource Name (ARN)
                                                                  	// entries.
                                                                  	ComputeEnvironments []string
                                                                  
                                                                  	// 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 isn't used, then
                                                                  	// DescribeComputeEnvironments returns up to 100 results and a nextToken value if
                                                                  	// applicable.
                                                                  	MaxResults int32
                                                                  
                                                                  	// 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's only used to retrieve the next items in a list and not for
                                                                  	// other programmatic purposes.
                                                                  	NextToken *string
                                                                  }

                                                                    Contains the parameters for DescribeComputeEnvironments.

                                                                    type DescribeComputeEnvironmentsOutput

                                                                    type DescribeComputeEnvironmentsOutput struct {
                                                                    
                                                                    	// The list of compute environments.
                                                                    	ComputeEnvironments []types.ComputeEnvironmentDetail
                                                                    
                                                                    	// 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
                                                                    
                                                                    	// Metadata pertaining to the operation's result.
                                                                    	ResultMetadata middleware.Metadata
                                                                    }

                                                                    type DescribeComputeEnvironmentsPaginator

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

                                                                      DescribeComputeEnvironmentsPaginator is a paginator for DescribeComputeEnvironments

                                                                      func NewDescribeComputeEnvironmentsPaginator

                                                                        NewDescribeComputeEnvironmentsPaginator returns a new DescribeComputeEnvironmentsPaginator

                                                                        func (*DescribeComputeEnvironmentsPaginator) HasMorePages

                                                                        func (p *DescribeComputeEnvironmentsPaginator) HasMorePages() bool

                                                                          HasMorePages returns a boolean indicating whether more pages are available

                                                                          func (*DescribeComputeEnvironmentsPaginator) NextPage

                                                                            NextPage retrieves the next DescribeComputeEnvironments page.

                                                                            type DescribeComputeEnvironmentsPaginatorOptions

                                                                            type DescribeComputeEnvironmentsPaginatorOptions struct {
                                                                            	// 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 isn't used, then
                                                                            	// DescribeComputeEnvironments returns up to 100 results and a nextToken value if
                                                                            	// applicable.
                                                                            	Limit int32
                                                                            
                                                                            	// Set to true if pagination should stop if the service returns a pagination token
                                                                            	// that matches the most recent token provided to the service.
                                                                            	StopOnDuplicateToken bool
                                                                            }

                                                                              DescribeComputeEnvironmentsPaginatorOptions is the paginator options for DescribeComputeEnvironments

                                                                              type DescribeJobDefinitionsAPIClient

                                                                              type DescribeJobDefinitionsAPIClient interface {
                                                                              	DescribeJobDefinitions(context.Context, *DescribeJobDefinitionsInput, ...func(*Options)) (*DescribeJobDefinitionsOutput, error)
                                                                              }

                                                                                DescribeJobDefinitionsAPIClient is a client that implements the DescribeJobDefinitions operation.

                                                                                type DescribeJobDefinitionsInput

                                                                                type DescribeJobDefinitionsInput struct {
                                                                                
                                                                                	// The name of the job definition to describe.
                                                                                	JobDefinitionName *string
                                                                                
                                                                                	// A list of up to 100 job definition names or full Amazon Resource Name (ARN)
                                                                                	// entries.
                                                                                	JobDefinitions []string
                                                                                
                                                                                	// 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 and 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 isn't used, then DescribeJobDefinitions
                                                                                	// returns up to 100 results and a nextToken value if applicable.
                                                                                	MaxResults int32
                                                                                
                                                                                	// 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's only used
                                                                                	// to retrieve the next items in a list and not for other programmatic purposes.
                                                                                	NextToken *string
                                                                                
                                                                                	// The status used to filter job definitions.
                                                                                	Status *string
                                                                                }

                                                                                  Contains the parameters for DescribeJobDefinitions.

                                                                                  type DescribeJobDefinitionsOutput

                                                                                  type DescribeJobDefinitionsOutput struct {
                                                                                  
                                                                                  	// The list of job definitions.
                                                                                  	JobDefinitions []types.JobDefinition
                                                                                  
                                                                                  	// 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
                                                                                  
                                                                                  	// Metadata pertaining to the operation's result.
                                                                                  	ResultMetadata middleware.Metadata
                                                                                  }

                                                                                  type DescribeJobDefinitionsPaginator

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

                                                                                    DescribeJobDefinitionsPaginator is a paginator for DescribeJobDefinitions

                                                                                    func NewDescribeJobDefinitionsPaginator

                                                                                      NewDescribeJobDefinitionsPaginator returns a new DescribeJobDefinitionsPaginator

                                                                                      func (*DescribeJobDefinitionsPaginator) HasMorePages

                                                                                      func (p *DescribeJobDefinitionsPaginator) HasMorePages() bool

                                                                                        HasMorePages returns a boolean indicating whether more pages are available

                                                                                        func (*DescribeJobDefinitionsPaginator) NextPage

                                                                                          NextPage retrieves the next DescribeJobDefinitions page.

                                                                                          type DescribeJobDefinitionsPaginatorOptions

                                                                                          type DescribeJobDefinitionsPaginatorOptions struct {
                                                                                          	// 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 and 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 isn't used, then DescribeJobDefinitions
                                                                                          	// returns up to 100 results and a nextToken value if applicable.
                                                                                          	Limit int32
                                                                                          
                                                                                          	// Set to true if pagination should stop if the service returns a pagination token
                                                                                          	// that matches the most recent token provided to the service.
                                                                                          	StopOnDuplicateToken bool
                                                                                          }

                                                                                            DescribeJobDefinitionsPaginatorOptions is the paginator options for DescribeJobDefinitions

                                                                                            type DescribeJobQueuesAPIClient

                                                                                            type DescribeJobQueuesAPIClient interface {
                                                                                            	DescribeJobQueues(context.Context, *DescribeJobQueuesInput, ...func(*Options)) (*DescribeJobQueuesOutput, error)
                                                                                            }

                                                                                              DescribeJobQueuesAPIClient is a client that implements the DescribeJobQueues operation.

                                                                                              type DescribeJobQueuesInput

                                                                                              type DescribeJobQueuesInput struct {
                                                                                              
                                                                                              	// A list of up to 100 queue names or full queue Amazon Resource Name (ARN)
                                                                                              	// entries.
                                                                                              	JobQueues []string
                                                                                              
                                                                                              	// 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 and 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 isn't used, then DescribeJobQueues returns up to 100 results and a
                                                                                              	// nextToken value if applicable.
                                                                                              	MaxResults int32
                                                                                              
                                                                                              	// 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's only used to
                                                                                              	// retrieve the next items in a list and not for other programmatic purposes.
                                                                                              	NextToken *string
                                                                                              }

                                                                                                Contains the parameters for DescribeJobQueues.

                                                                                                type DescribeJobQueuesOutput

                                                                                                type DescribeJobQueuesOutput struct {
                                                                                                
                                                                                                	// The list of job queues.
                                                                                                	JobQueues []types.JobQueueDetail
                                                                                                
                                                                                                	// 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
                                                                                                
                                                                                                	// Metadata pertaining to the operation's result.
                                                                                                	ResultMetadata middleware.Metadata
                                                                                                }

                                                                                                type DescribeJobQueuesPaginator

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

                                                                                                  DescribeJobQueuesPaginator is a paginator for DescribeJobQueues

                                                                                                  func NewDescribeJobQueuesPaginator

                                                                                                  func NewDescribeJobQueuesPaginator(client DescribeJobQueuesAPIClient, params *DescribeJobQueuesInput, optFns ...func(*DescribeJobQueuesPaginatorOptions)) *DescribeJobQueuesPaginator

                                                                                                    NewDescribeJobQueuesPaginator returns a new DescribeJobQueuesPaginator

                                                                                                    func (*DescribeJobQueuesPaginator) HasMorePages

                                                                                                    func (p *DescribeJobQueuesPaginator) HasMorePages() bool

                                                                                                      HasMorePages returns a boolean indicating whether more pages are available

                                                                                                      func (*DescribeJobQueuesPaginator) NextPage

                                                                                                      func (p *DescribeJobQueuesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeJobQueuesOutput, error)

                                                                                                        NextPage retrieves the next DescribeJobQueues page.

                                                                                                        type DescribeJobQueuesPaginatorOptions

                                                                                                        type DescribeJobQueuesPaginatorOptions struct {
                                                                                                        	// 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 and 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 isn't used, then DescribeJobQueues returns up to 100 results and a
                                                                                                        	// nextToken value if applicable.
                                                                                                        	Limit int32
                                                                                                        
                                                                                                        	// Set to true if pagination should stop if the service returns a pagination token
                                                                                                        	// that matches the most recent token provided to the service.
                                                                                                        	StopOnDuplicateToken bool
                                                                                                        }

                                                                                                          DescribeJobQueuesPaginatorOptions is the paginator options for DescribeJobQueues

                                                                                                          type DescribeJobsInput

                                                                                                          type DescribeJobsInput struct {
                                                                                                          
                                                                                                          	// A list of up to 100 job IDs.
                                                                                                          	//
                                                                                                          	// This member is required.
                                                                                                          	Jobs []string
                                                                                                          }

                                                                                                            Contains the parameters for DescribeJobs.

                                                                                                            type DescribeJobsOutput

                                                                                                            type DescribeJobsOutput struct {
                                                                                                            
                                                                                                            	// The list of jobs.
                                                                                                            	Jobs []types.JobDetail
                                                                                                            
                                                                                                            	// Metadata pertaining to the operation's result.
                                                                                                            	ResultMetadata middleware.Metadata
                                                                                                            }

                                                                                                            type EndpointResolver

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

                                                                                                              EndpointResolver interface for resolving service endpoints.

                                                                                                              func EndpointResolverFromURL

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

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

                                                                                                                type EndpointResolverFunc

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

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

                                                                                                                  func (EndpointResolverFunc) ResolveEndpoint

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

                                                                                                                  type EndpointResolverOptions

                                                                                                                  type EndpointResolverOptions = internalendpoints.Options

                                                                                                                    EndpointResolverOptions is the service endpoint resolver options

                                                                                                                    type HTTPClient

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

                                                                                                                    type HTTPSignerV4

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

                                                                                                                    type ListJobsAPIClient

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

                                                                                                                      ListJobsAPIClient is a client that implements the ListJobs operation.

                                                                                                                      type ListJobsInput

                                                                                                                      type ListJobsInput struct {
                                                                                                                      
                                                                                                                      	// The 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
                                                                                                                      
                                                                                                                      	// The name or full Amazon Resource Name (ARN) of the job queue used to list jobs.
                                                                                                                      	JobQueue *string
                                                                                                                      
                                                                                                                      	// The job status used to filter jobs in the specified queue. If you don't specify
                                                                                                                      	// a status, only RUNNING jobs are returned.
                                                                                                                      	JobStatus types.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 and 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 isn't
                                                                                                                      	// used, then ListJobs returns up to 100 results and a nextToken value if
                                                                                                                      	// applicable.
                                                                                                                      	MaxResults int32
                                                                                                                      
                                                                                                                      	// 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
                                                                                                                      
                                                                                                                      	// 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's only used to
                                                                                                                      	// retrieve the next items in a list and not for other programmatic purposes.
                                                                                                                      	NextToken *string
                                                                                                                      }

                                                                                                                        Contains the parameters for ListJobs.

                                                                                                                        type ListJobsOutput

                                                                                                                        type ListJobsOutput struct {
                                                                                                                        
                                                                                                                        	// A list of job summaries that match the request.
                                                                                                                        	//
                                                                                                                        	// This member is required.
                                                                                                                        	JobSummaryList []types.JobSummary
                                                                                                                        
                                                                                                                        	// 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
                                                                                                                        
                                                                                                                        	// Metadata pertaining to the operation's result.
                                                                                                                        	ResultMetadata middleware.Metadata
                                                                                                                        }

                                                                                                                        type ListJobsPaginator

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

                                                                                                                          ListJobsPaginator is a paginator for ListJobs

                                                                                                                          func NewListJobsPaginator

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

                                                                                                                            NewListJobsPaginator returns a new ListJobsPaginator

                                                                                                                            func (*ListJobsPaginator) HasMorePages

                                                                                                                            func (p *ListJobsPaginator) HasMorePages() bool

                                                                                                                              HasMorePages returns a boolean indicating whether more pages are available

                                                                                                                              func (*ListJobsPaginator) NextPage

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

                                                                                                                                NextPage retrieves the next ListJobs page.

                                                                                                                                type ListJobsPaginatorOptions

                                                                                                                                type ListJobsPaginatorOptions struct {
                                                                                                                                	// The maximum number of results returned by ListJobs in paginated output. When
                                                                                                                                	// this parameter is used, ListJobs only returns maxResults results in a single
                                                                                                                                	// page and 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 isn't
                                                                                                                                	// used, then ListJobs returns up to 100 results and a nextToken value if
                                                                                                                                	// applicable.
                                                                                                                                	Limit int32
                                                                                                                                
                                                                                                                                	// Set to true if pagination should stop if the service returns a pagination token
                                                                                                                                	// that matches the most recent token provided to the service.
                                                                                                                                	StopOnDuplicateToken bool
                                                                                                                                }

                                                                                                                                  ListJobsPaginatorOptions is the paginator options for ListJobs

                                                                                                                                  type ListTagsForResourceInput

                                                                                                                                  type ListTagsForResourceInput struct {
                                                                                                                                  
                                                                                                                                  	// The Amazon Resource Name (ARN) that identifies the resource that tags are listed
                                                                                                                                  	// for. AWS Batch resources that support tags are compute environments, jobs, job
                                                                                                                                  	// definitions, and job queues. ARNs for child jobs of array and multi-node
                                                                                                                                  	// parallel (MNP) jobs are not supported.
                                                                                                                                  	//
                                                                                                                                  	// This member is required.
                                                                                                                                  	ResourceArn *string
                                                                                                                                  }

                                                                                                                                  type ListTagsForResourceOutput

                                                                                                                                  type ListTagsForResourceOutput struct {
                                                                                                                                  
                                                                                                                                  	// The tags for the resource.
                                                                                                                                  	Tags map[string]string
                                                                                                                                  
                                                                                                                                  	// Metadata pertaining to the operation's result.
                                                                                                                                  	ResultMetadata middleware.Metadata
                                                                                                                                  }

                                                                                                                                  type Options

                                                                                                                                  type Options struct {
                                                                                                                                  	// Set of options to modify how an operation is invoked. These apply to all
                                                                                                                                  	// operations invoked for this client. Use functional options on operation call to
                                                                                                                                  	// modify this list for per operation behavior.
                                                                                                                                  	APIOptions []func(*middleware.Stack) error
                                                                                                                                  
                                                                                                                                  	// Configures the events that will be sent to the configured logger.
                                                                                                                                  	ClientLogMode aws.ClientLogMode
                                                                                                                                  
                                                                                                                                  	// The credentials object to use when signing requests.
                                                                                                                                  	Credentials aws.CredentialsProvider
                                                                                                                                  
                                                                                                                                  	// The endpoint options to be used when attempting to resolve an endpoint.
                                                                                                                                  	EndpointOptions EndpointResolverOptions
                                                                                                                                  
                                                                                                                                  	// The service endpoint resolver.
                                                                                                                                  	EndpointResolver EndpointResolver
                                                                                                                                  
                                                                                                                                  	// Signature Version 4 (SigV4) Signer
                                                                                                                                  	HTTPSignerV4 HTTPSignerV4
                                                                                                                                  
                                                                                                                                  	// The logger writer interface to write logging messages to.
                                                                                                                                  	Logger logging.Logger
                                                                                                                                  
                                                                                                                                  	// The region to send requests to. (Required)
                                                                                                                                  	Region string
                                                                                                                                  
                                                                                                                                  	// Retryer guides how HTTP requests should be retried in case of recoverable
                                                                                                                                  	// failures. When nil the API client will use a default retryer.
                                                                                                                                  	Retryer aws.Retryer
                                                                                                                                  
                                                                                                                                  	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
                                                                                                                                  	// implementation if nil.
                                                                                                                                  	HTTPClient HTTPClient
                                                                                                                                  }

                                                                                                                                  func (Options) Copy

                                                                                                                                  func (o Options) Copy() Options

                                                                                                                                    Copy creates a clone where the APIOptions list is deep copied.

                                                                                                                                    type RegisterJobDefinitionInput

                                                                                                                                    type RegisterJobDefinitionInput struct {
                                                                                                                                    
                                                                                                                                    	// The name of the job definition to register. Up to 128 letters (uppercase and
                                                                                                                                    	// lowercase), numbers, hyphens, and underscores are allowed.
                                                                                                                                    	//
                                                                                                                                    	// This member is required.
                                                                                                                                    	JobDefinitionName *string
                                                                                                                                    
                                                                                                                                    	// The type of job definition. For more information about multi-node parallel jobs,
                                                                                                                                    	// see Creating a multi-node parallel job definition
                                                                                                                                    	// (https://docs.aws.amazon.com/batch/latest/userguide/multi-node-job-def.html) in
                                                                                                                                    	// the AWS Batch User Guide. If the job is run on Fargate resources, then multinode
                                                                                                                                    	// isn't supported.
                                                                                                                                    	//
                                                                                                                                    	// This member is required.
                                                                                                                                    	Type types.JobDefinitionType
                                                                                                                                    
                                                                                                                                    	// 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. If the job runs on Fargate
                                                                                                                                    	// resources, then you must not specify nodeProperties; use only
                                                                                                                                    	// containerProperties.
                                                                                                                                    	ContainerProperties *types.ContainerProperties
                                                                                                                                    
                                                                                                                                    	// 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.
                                                                                                                                    	// If the job runs on Fargate resources, then you must not specify nodeProperties;
                                                                                                                                    	// use containerProperties instead.
                                                                                                                                    	NodeProperties *types.NodeProperties
                                                                                                                                    
                                                                                                                                    	// 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
                                                                                                                                    
                                                                                                                                    	// The platform capabilities required by the job definition. If no value is
                                                                                                                                    	// specified, it defaults to EC2. To run the job on Fargate resources, specify
                                                                                                                                    	// FARGATE.
                                                                                                                                    	PlatformCapabilities []types.PlatformCapability
                                                                                                                                    
                                                                                                                                    	// Specifies whether to propagate the tags from the job or job definition to the
                                                                                                                                    	// corresponding Amazon ECS task. If no value is specified, the tags are not
                                                                                                                                    	// propagated. Tags can only be propagated to the tasks during task creation. For
                                                                                                                                    	// tags with the same name, job tags are given priority over job definitions tags.
                                                                                                                                    	// If the total number of combined tags from the job and job definition is over 50,
                                                                                                                                    	// the job is moved to the FAILED state.
                                                                                                                                    	PropagateTags bool
                                                                                                                                    
                                                                                                                                    	// The retry strategy to use for failed jobs that are submitted with this job
                                                                                                                                    	// definition. Any retry strategy that's specified during a SubmitJob operation
                                                                                                                                    	// overrides the retry strategy defined here. If a job is terminated due to a
                                                                                                                                    	// timeout, it isn't retried.
                                                                                                                                    	RetryStrategy *types.RetryStrategy
                                                                                                                                    
                                                                                                                                    	// The tags that you apply to the job definition to help you categorize and
                                                                                                                                    	// organize your resources. Each tag consists of a key and an optional value. For
                                                                                                                                    	// more information, see Tagging AWS Resources
                                                                                                                                    	// (https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html) in AWS
                                                                                                                                    	// Batch User Guide.
                                                                                                                                    	Tags map[string]string
                                                                                                                                    
                                                                                                                                    	// 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 isn't retried. The minimum value for the
                                                                                                                                    	// timeout is 60 seconds. Any timeout configuration that's specified during a
                                                                                                                                    	// SubmitJob operation overrides the timeout configuration defined here. For more
                                                                                                                                    	// information, see Job Timeouts
                                                                                                                                    	// (https://docs.aws.amazon.com/batch/latest/userguide/job_timeouts.html) in the
                                                                                                                                    	// AWS Batch User Guide.
                                                                                                                                    	Timeout *types.JobTimeout
                                                                                                                                    }

                                                                                                                                      Contains the parameters for RegisterJobDefinition.

                                                                                                                                      type RegisterJobDefinitionOutput

                                                                                                                                      type RegisterJobDefinitionOutput struct {
                                                                                                                                      
                                                                                                                                      	// The Amazon Resource Name (ARN) of the job definition.
                                                                                                                                      	//
                                                                                                                                      	// This member is required.
                                                                                                                                      	JobDefinitionArn *string
                                                                                                                                      
                                                                                                                                      	// The name of the job definition.
                                                                                                                                      	//
                                                                                                                                      	// This member is required.
                                                                                                                                      	JobDefinitionName *string
                                                                                                                                      
                                                                                                                                      	// The revision of the job definition.
                                                                                                                                      	//
                                                                                                                                      	// This member is required.
                                                                                                                                      	Revision int32
                                                                                                                                      
                                                                                                                                      	// Metadata pertaining to the operation's result.
                                                                                                                                      	ResultMetadata middleware.Metadata
                                                                                                                                      }

                                                                                                                                      type ResolveEndpoint

                                                                                                                                      type ResolveEndpoint struct {
                                                                                                                                      	Resolver EndpointResolver
                                                                                                                                      	Options  EndpointResolverOptions
                                                                                                                                      }

                                                                                                                                      func (*ResolveEndpoint) HandleSerialize

                                                                                                                                      func (*ResolveEndpoint) ID

                                                                                                                                      func (*ResolveEndpoint) ID() string

                                                                                                                                      type SubmitJobInput

                                                                                                                                      type SubmitJobInput struct {
                                                                                                                                      
                                                                                                                                      	// The job definition used by this job. This value can be one of name,
                                                                                                                                      	// name:revision, or the Amazon Resource Name (ARN) for the job definition. If name
                                                                                                                                      	// is specified without a revision then the latest active revision is used.
                                                                                                                                      	//
                                                                                                                                      	// This member is required.
                                                                                                                                      	JobDefinition *string
                                                                                                                                      
                                                                                                                                      	// 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.
                                                                                                                                      	//
                                                                                                                                      	// This member is required.
                                                                                                                                      	JobName *string
                                                                                                                                      
                                                                                                                                      	// The job queue where the job is submitted. You can specify either the name or the
                                                                                                                                      	// Amazon Resource Name (ARN) of the queue.
                                                                                                                                      	//
                                                                                                                                      	// This member is required.
                                                                                                                                      	JobQueue *string
                                                                                                                                      
                                                                                                                                      	// 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 *types.ArrayProperties
                                                                                                                                      
                                                                                                                                      	// A list of container overrides in the 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, which is specified in the
                                                                                                                                      	// job definition or the Docker image, with a command override. You can also
                                                                                                                                      	// override existing environment variables on a container or add new environment
                                                                                                                                      	// variables to it with an environment override.
                                                                                                                                      	ContainerOverrides *types.ContainerOverrides
                                                                                                                                      
                                                                                                                                      	// 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 []types.JobDependency
                                                                                                                                      
                                                                                                                                      	// A list of node overrides in JSON format that specify the node range to target
                                                                                                                                      	// and the container overrides for that node range. This parameter isn't applicable
                                                                                                                                      	// to jobs running on Fargate resources; use containerOverrides instead.
                                                                                                                                      	NodeOverrides *types.NodeOverrides
                                                                                                                                      
                                                                                                                                      	// 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
                                                                                                                                      
                                                                                                                                      	// Specifies whether to propagate the tags from the job or job definition to the
                                                                                                                                      	// corresponding Amazon ECS task. If no value is specified, the tags aren't
                                                                                                                                      	// propagated. Tags can only be propagated to the tasks during task creation. For
                                                                                                                                      	// tags with the same name, job tags are given priority over job definitions tags.
                                                                                                                                      	// If the total number of combined tags from the job and job definition is over 50,
                                                                                                                                      	// the job is moved to the FAILED state. When specified, this overrides the tag
                                                                                                                                      	// propagation setting in the job definition.
                                                                                                                                      	PropagateTags bool
                                                                                                                                      
                                                                                                                                      	// 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 *types.RetryStrategy
                                                                                                                                      
                                                                                                                                      	// The tags that you apply to the job request to help you categorize and organize
                                                                                                                                      	// your resources. Each tag consists of a key and an optional value. For more
                                                                                                                                      	// information, see Tagging AWS Resources
                                                                                                                                      	// (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in AWS General
                                                                                                                                      	// Reference.
                                                                                                                                      	Tags map[string]string
                                                                                                                                      
                                                                                                                                      	// The timeout configuration for this SubmitJob operation. You can specify a
                                                                                                                                      	// timeout duration after which AWS Batch terminates your jobs if they haven't
                                                                                                                                      	// finished. If a job is terminated due to a timeout, it isn't 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 *types.JobTimeout
                                                                                                                                      }

                                                                                                                                        Contains the parameters for SubmitJob.

                                                                                                                                        type SubmitJobOutput

                                                                                                                                        type SubmitJobOutput struct {
                                                                                                                                        
                                                                                                                                        	// The unique identifier for the job.
                                                                                                                                        	//
                                                                                                                                        	// This member is required.
                                                                                                                                        	JobId *string
                                                                                                                                        
                                                                                                                                        	// The name of the job.
                                                                                                                                        	//
                                                                                                                                        	// This member is required.
                                                                                                                                        	JobName *string
                                                                                                                                        
                                                                                                                                        	// The Amazon Resource Name (ARN) for the job.
                                                                                                                                        	JobArn *string
                                                                                                                                        
                                                                                                                                        	// Metadata pertaining to the operation's result.
                                                                                                                                        	ResultMetadata middleware.Metadata
                                                                                                                                        }

                                                                                                                                        type TagResourceInput

                                                                                                                                        type TagResourceInput struct {
                                                                                                                                        
                                                                                                                                        	// The Amazon Resource Name (ARN) of the resource that tags are added to. AWS Batch
                                                                                                                                        	// resources that support tags are compute environments, jobs, job definitions, and
                                                                                                                                        	// job queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are
                                                                                                                                        	// not supported.
                                                                                                                                        	//
                                                                                                                                        	// This member is required.
                                                                                                                                        	ResourceArn *string
                                                                                                                                        
                                                                                                                                        	// The tags that you apply to the resource to help you categorize and organize your
                                                                                                                                        	// resources. Each tag consists of a key and an optional value. For more
                                                                                                                                        	// information, see Tagging AWS Resources
                                                                                                                                        	// (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in AWS General
                                                                                                                                        	// Reference.
                                                                                                                                        	//
                                                                                                                                        	// This member is required.
                                                                                                                                        	Tags map[string]string
                                                                                                                                        }

                                                                                                                                        type TagResourceOutput

                                                                                                                                        type TagResourceOutput struct {
                                                                                                                                        	// Metadata pertaining to the operation's result.
                                                                                                                                        	ResultMetadata middleware.Metadata
                                                                                                                                        }

                                                                                                                                        type TerminateJobInput

                                                                                                                                        type TerminateJobInput struct {
                                                                                                                                        
                                                                                                                                        	// The AWS Batch job ID of the job to terminate.
                                                                                                                                        	//
                                                                                                                                        	// This member is required.
                                                                                                                                        	JobId *string
                                                                                                                                        
                                                                                                                                        	// 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.
                                                                                                                                        	//
                                                                                                                                        	// This member is required.
                                                                                                                                        	Reason *string
                                                                                                                                        }

                                                                                                                                          Contains the parameters for TerminateJob.

                                                                                                                                          type TerminateJobOutput

                                                                                                                                          type TerminateJobOutput struct {
                                                                                                                                          	// Metadata pertaining to the operation's result.
                                                                                                                                          	ResultMetadata middleware.Metadata
                                                                                                                                          }

                                                                                                                                          type UntagResourceInput

                                                                                                                                          type UntagResourceInput struct {
                                                                                                                                          
                                                                                                                                          	// The Amazon Resource Name (ARN) of the resource from which to delete tags. AWS
                                                                                                                                          	// Batch resources that support tags are compute environments, jobs, job
                                                                                                                                          	// definitions, and job queues. ARNs for child jobs of array and multi-node
                                                                                                                                          	// parallel (MNP) jobs are not supported.
                                                                                                                                          	//
                                                                                                                                          	// This member is required.
                                                                                                                                          	ResourceArn *string
                                                                                                                                          
                                                                                                                                          	// The keys of the tags to be removed.
                                                                                                                                          	//
                                                                                                                                          	// This member is required.
                                                                                                                                          	TagKeys []string
                                                                                                                                          }

                                                                                                                                          type UntagResourceOutput

                                                                                                                                          type UntagResourceOutput struct {
                                                                                                                                          	// Metadata pertaining to the operation's result.
                                                                                                                                          	ResultMetadata middleware.Metadata
                                                                                                                                          }

                                                                                                                                          type UpdateComputeEnvironmentInput

                                                                                                                                          type UpdateComputeEnvironmentInput struct {
                                                                                                                                          
                                                                                                                                          	// The name or full Amazon Resource Name (ARN) of the compute environment to
                                                                                                                                          	// update.
                                                                                                                                          	//
                                                                                                                                          	// This member is required.
                                                                                                                                          	ComputeEnvironment *string
                                                                                                                                          
                                                                                                                                          	// Details of the compute resources managed by the compute environment. Required
                                                                                                                                          	// for a managed 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.
                                                                                                                                          	ComputeResources *types.ComputeResourceUpdate
                                                                                                                                          
                                                                                                                                          	// The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to
                                                                                                                                          	// make calls to other AWS services on your behalf. For more information, see AWS
                                                                                                                                          	// Batch service IAM role
                                                                                                                                          	// (https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html) in
                                                                                                                                          	// the AWS Batch User Guide. If the compute environment has a service-linked role,
                                                                                                                                          	// it cannot be changed to use a regular IAM role. If the compute environment has a
                                                                                                                                          	// regular IAM role, it cannot be changed to use a service-linked role. 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 might contain the
                                                                                                                                          	// service-role path prefix. When you only specify the name of the service role,
                                                                                                                                          	// AWS Batch assumes that your ARN doesn't 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
                                                                                                                                          
                                                                                                                                          	// 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. 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 doesn't 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 don't scale out. However, they scale in to minvCpus value after instances
                                                                                                                                          	// become idle.
                                                                                                                                          	State types.CEState
                                                                                                                                          }

                                                                                                                                            Contains the parameters for UpdateComputeEnvironment.

                                                                                                                                            type UpdateComputeEnvironmentOutput

                                                                                                                                            type UpdateComputeEnvironmentOutput struct {
                                                                                                                                            
                                                                                                                                            	// The Amazon Resource Name (ARN) of the compute environment.
                                                                                                                                            	ComputeEnvironmentArn *string
                                                                                                                                            
                                                                                                                                            	// The name of the compute environment. Up to 128 letters (uppercase and
                                                                                                                                            	// lowercase), numbers, hyphens, and underscores are allowed.
                                                                                                                                            	ComputeEnvironmentName *string
                                                                                                                                            
                                                                                                                                            	// Metadata pertaining to the operation's result.
                                                                                                                                            	ResultMetadata middleware.Metadata
                                                                                                                                            }

                                                                                                                                            type UpdateJobQueueInput

                                                                                                                                            type UpdateJobQueueInput struct {
                                                                                                                                            
                                                                                                                                            	// The name or the Amazon Resource Name (ARN) of the job queue.
                                                                                                                                            	//
                                                                                                                                            	// This member is required.
                                                                                                                                            	JobQueue *string
                                                                                                                                            
                                                                                                                                            	// 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 run a given job. Compute
                                                                                                                                            	// environments must be in the VALID state before you can associate them with a job
                                                                                                                                            	// queue. All of the compute environments must be either EC2 (EC2 or SPOT) or
                                                                                                                                            	// Fargate (FARGATE or FARGATE_SPOT). EC2 and Fargate compute environments can't be
                                                                                                                                            	// mixed. All compute environments that are associated with a job queue must share
                                                                                                                                            	// the same architecture. AWS Batch doesn't support mixing compute environment
                                                                                                                                            	// architecture types in a single job queue.
                                                                                                                                            	ComputeEnvironmentOrder []types.ComputeEnvironmentOrder
                                                                                                                                            
                                                                                                                                            	// 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. All of the compute
                                                                                                                                            	// environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or
                                                                                                                                            	// FARGATE_SPOT). EC2 and Fargate compute environments can't be mixed.
                                                                                                                                            	Priority int32
                                                                                                                                            
                                                                                                                                            	// Describes the queue's ability to accept new jobs. If the job queue state is
                                                                                                                                            	// ENABLED, it can accept jobs. If the job queue state is DISABLED, new jobs can't
                                                                                                                                            	// be added to the queue, but jobs already in the queue can finish.
                                                                                                                                            	State types.JQState
                                                                                                                                            }

                                                                                                                                              Contains the parameters for UpdateJobQueue.

                                                                                                                                              type UpdateJobQueueOutput

                                                                                                                                              type UpdateJobQueueOutput struct {
                                                                                                                                              
                                                                                                                                              	// The Amazon Resource Name (ARN) of the job queue.
                                                                                                                                              	JobQueueArn *string
                                                                                                                                              
                                                                                                                                              	// The name of the job queue.
                                                                                                                                              	JobQueueName *string
                                                                                                                                              
                                                                                                                                              	// Metadata pertaining to the operation's result.
                                                                                                                                              	ResultMetadata middleware.Metadata
                                                                                                                                              }

                                                                                                                                              Directories

                                                                                                                                              Path Synopsis
                                                                                                                                              internal