batch

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

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

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

type CreateComputeEnvironmentInput struct {
	// The state of the compute environment. If the state is ENABLED, then the compute
	// environment accepts jobs from a queue and can scale out automatically based on
	// queues.
	State types.CEState
	// The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to
	// make calls to other AWS services on your behalf. If your specified role has a
	// path other than /, then you must either specify the full role ARN (this is
	// recommended) or prefix the role name with the path. Depending on how you created
	// your AWS Batch service role, its ARN may contain the service-role path prefix.
	// When you only specify the name of the service role, AWS Batch assumes that your
	// ARN does not use the service-role path prefix. Because of this, we recommend
	// that you specify the full ARN of your service role when you create compute
	// environments.
	ServiceRole *string
	// Details of the compute resources managed by the compute environment. This
	// parameter is required for managed compute environments. For more information,
	// see Compute Environments
	// (https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html)
	// in the AWS Batch User Guide.
	ComputeResources *types.ComputeResource
	// The name for your compute environment. Up to 128 letters (uppercase and
	// lowercase), numbers, hyphens, and underscores are allowed.
	ComputeEnvironmentName *string
	// The type of the compute environment. For more information, see Compute
	// Environments
	// (https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html)
	// in the AWS Batch User Guide.
	Type types.CEType
}

type CreateComputeEnvironmentOutput struct {
	// The Amazon Resource Name (ARN) of the compute environment.
	ComputeEnvironmentArn *string
	// The name of the compute environment.
	ComputeEnvironmentName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateJobQueueInput struct {
	// The name of the job queue.
	JobQueueName *string
	// The set of compute environments mapped to a job queue and their order relative
	// to each other. The job scheduler uses this parameter to determine which compute
	// environment should execute a given job. Compute environments must be in the
	// VALID state before you can associate them with a job queue. You can associate up
	// to three compute environments with a job queue.
	ComputeEnvironmentOrder []*types.ComputeEnvironmentOrder
	// The state of the job queue. If the job queue state is ENABLED, it is able to
	// accept jobs.
	State types.JQState
	// The priority of the job queue. Job queues with a higher priority (or a higher
	// integer value for the priority parameter) are evaluated first when associated
	// with the same compute environment. Priority is determined in descending order,
	// for example, a job queue with a priority value of 10 is given scheduling
	// preference over a job queue with a priority value of 1.
	Priority *int32
}

type CreateJobQueueOutput struct {
	// The name of the job queue.
	JobQueueName *string
	// The Amazon Resource Name (ARN) of the job queue.
	JobQueueArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

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

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

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

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

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

type DescribeComputeEnvironmentsInput struct {
	// A list of up to 100 compute environment names or full Amazon Resource Name (ARN)
	// entries.
	ComputeEnvironments []*string
	// The nextToken value returned from a previous paginated
	// DescribeComputeEnvironments request where maxResults was used and the results
	// exceeded the value of that parameter. Pagination continues from the end of the
	// previous results that returned the nextToken value. This value is null when
	// there are no more results to return. This token should be treated as an opaque
	// identifier that is only used to retrieve the next items in a list and not for
	// other programmatic purposes.
	NextToken *string
	// The maximum number of cluster results returned by DescribeComputeEnvironments in
	// paginated output. When this parameter is used, DescribeComputeEnvironments only
	// returns maxResults results in a single page along with a nextToken response
	// element. The remaining results of the initial request can be seen by sending
	// another DescribeComputeEnvironments request with the returned nextToken value.
	// This value can be between 1 and 100. If this parameter is not used, then
	// DescribeComputeEnvironments returns up to 100 results and a nextToken value if
	// applicable.
	MaxResults *int32
}

type DescribeComputeEnvironmentsOutput struct {
	// 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
	// The list of compute environments.
	ComputeEnvironments []*types.ComputeEnvironmentDetail

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeJobDefinitionsInput struct {
	// The status with which to filter job definitions.
	Status *string
	// The nextToken value returned from a previous paginated DescribeJobDefinitions
	// request where maxResults was used and the results exceeded the value of that
	// parameter. Pagination continues from the end of the previous results that
	// returned the nextToken value. This value is null when there are no more results
	// to return. This token should be treated as an opaque identifier that is only
	// used to retrieve the next items in a list and not for other programmatic
	// purposes.
	NextToken *string
	// The maximum number of results returned by DescribeJobDefinitions in paginated
	// output. When this parameter is used, DescribeJobDefinitions only returns
	// maxResults results in a single page along with a nextToken response element. The
	// remaining results of the initial request can be seen by sending another
	// DescribeJobDefinitions request with the returned nextToken value. This value can
	// be between 1 and 100. If this parameter is not used, then DescribeJobDefinitions
	// returns up to 100 results and a nextToken value if applicable.
	MaxResults *int32
	// A list of up to 100 job definition names or full Amazon Resource Name (ARN)
	// entries.
	JobDefinitions []*string
	// The name of the job definition to describe.
	JobDefinitionName *string
}

type DescribeJobDefinitionsOutput struct {
	// 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
	// The list of job definitions.
	JobDefinitions []*types.JobDefinition

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeJobQueuesInput struct {
	// The nextToken value returned from a previous paginated DescribeJobQueues request
	// where maxResults was used and the results exceeded the value of that parameter.
	// Pagination continues from the end of the previous results that returned the
	// nextToken value. This value is null when there are no more results to return.
	// This token should be treated as an opaque identifier that is only used to
	// retrieve the next items in a list and not for other programmatic purposes.
	NextToken *string
	// 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 along with a nextToken response element. The remaining results
	// of the initial request can be seen by sending another DescribeJobQueues request
	// with the returned nextToken value. This value can be between 1 and 100. If this
	// parameter is not used, then DescribeJobQueues returns up to 100 results and a
	// nextToken value if applicable.
	MaxResults *int32
}

type DescribeJobQueuesOutput struct {
	// 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
	// The list of job queues.
	JobQueues []*types.JobQueueDetail

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeJobsInput struct {
	// A list of up to 100 job IDs.
	Jobs []*string
}

type DescribeJobsOutput struct {
	// The list of jobs.
	Jobs []*types.JobDetail

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

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

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

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

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 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 maximum number of results returned by ListJobs in paginated output. When
	// this parameter is used, ListJobs only returns maxResults results in a single
	// page along with a nextToken response element. The remaining results of the
	// initial request can be seen by sending another ListJobs request with the
	// returned nextToken value. This value can be between 1 and 100. If this parameter
	// is not used, then ListJobs returns up to 100 results and a nextToken value if
	// applicable.
	MaxResults *int32
	// The job status with which to filter jobs in the specified queue. If you do not
	// specify a status, only RUNNING jobs are returned.
	JobStatus types.JobStatus
	// The name or full Amazon Resource Name (ARN) of the job queue with which to list
	// jobs.
	JobQueue *string
	// The nextToken value returned from a previous paginated ListJobs request where
	// maxResults was used and the results exceeded the value of that parameter.
	// Pagination continues from the end of the previous results that returned the
	// nextToken value. This value is null when there are no more results to return.
	// This token should be treated as an opaque identifier that is only used to
	// retrieve the next items in a list and not for other programmatic purposes.
	NextToken *string
}

type ListJobsOutput struct {
	// A list of job summaries that match the request.
	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 Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions ResolverOptions

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// 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 retry.Retryer

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient
}

type RegisterJobDefinitionInput struct {
	// An object with various properties specific to multi-node parallel jobs. If you
	// specify node properties for a job, it becomes a multi-node parallel job. For
	// more information, see Multi-node Parallel Jobs
	// (https://docs.aws.amazon.com/batch/latest/userguide/multi-node-parallel-jobs.html)
	// in the AWS Batch User Guide. If the job definition's type parameter is
	// container, then you must specify either containerProperties or nodeProperties.
	NodeProperties *types.NodeProperties
	// An object with various properties specific to single-node container-based jobs.
	// If the job definition's type parameter is container, then you must specify
	// either containerProperties or nodeProperties.
	ContainerProperties *types.ContainerProperties
	// The retry strategy to use for failed jobs that are submitted with this job
	// definition. Any retry strategy that is specified during a SubmitJob () operation
	// overrides the retry strategy defined here. If a job is terminated due to a
	// timeout, it is not retried.
	RetryStrategy *types.RetryStrategy
	// The type of job definition.
	Type types.JobDefinitionType
	// 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 name of the job definition to register. Up to 128 letters (uppercase and
	// lowercase), numbers, hyphens, and underscores are allowed.
	JobDefinitionName *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 is not retried. The minimum value for the
	// timeout is 60 seconds. Any timeout configuration that is specified during a
	// SubmitJob () operation overrides the timeout configuration defined here. For
	// more information, see Job Timeouts
	// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/job_timeouts.html)
	// in the Amazon Elastic Container Service Developer Guide.
	Timeout *types.JobTimeout
}

type RegisterJobDefinitionOutput struct {
	// The revision of the job definition.
	Revision *int32
	// The name of the job definition.
	JobDefinitionName *string
	// The Amazon Resource Name (ARN) of the job definition.
	JobDefinitionArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  ResolverOptions
}

type ResolveEndpointMiddlewareOptions interface {
	GetEndpointResolver() EndpointResolver
	GetEndpointOptions() ResolverOptions
}

type ResolverOptions = internalendpoints.Options

type SubmitJobInput struct {
	// The array properties for the submitted job, such as the size of the array. The
	// array size can be between 2 and 10,000. If you specify array properties for a
	// job, it becomes an array job. For more information, see Array Jobs
	// (https://docs.aws.amazon.com/batch/latest/userguide/array_jobs.html) in the AWS
	// Batch User Guide.
	ArrayProperties *types.ArrayProperties
	// 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
	// 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
	// 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
	// A list of container overrides in JSON format that specify the name of a
	// container in the specified job definition and the overrides it should receive.
	// You can override the default command for a container (that is specified in the
	// job definition or the Docker image) with a command override. You can also
	// override existing environment variables (that are specified in the job
	// definition or Docker image) on a container or add new environment variables to
	// it with an environment override.
	ContainerOverrides *types.ContainerOverrides
	// A list of node overrides in JSON format that specify the node range to target
	// and the container overrides for that node range.
	NodeOverrides *types.NodeOverrides
	// The job queue into which the job is submitted. You can specify either the name
	// or the Amazon Resource Name (ARN) of the queue.
	JobQueue *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.
	JobName *string
	// The timeout configuration for this SubmitJob () operation. You can specify a
	// timeout duration after which AWS Batch terminates your jobs if they have not
	// finished. If a job is terminated due to a timeout, it is not retried. The
	// minimum value for the timeout is 60 seconds. This configuration overrides any
	// timeout configuration specified in the job definition. For array jobs, child
	// jobs have the same timeout configuration as the parent job. For more
	// information, see Job Timeouts
	// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/job_timeouts.html)
	// in the Amazon Elastic Container Service Developer Guide.
	Timeout *types.JobTimeout
	// 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.
	JobDefinition *string
}

type SubmitJobOutput struct {
	// The unique identifier for the job.
	JobId *string
	// The name of the job.
	JobName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type TerminateJobInput struct {
	// A message to attach to the job that explains the reason for canceling it. This
	// message is returned by future DescribeJobs () operations on the job. This
	// message is also recorded in the AWS Batch activity logs.
	Reason *string
	// The AWS Batch job ID of the job to terminate.
	JobId *string
}

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

type UpdateComputeEnvironmentInput struct {
	// Details of the compute resources managed by the compute environment. Required
	// for a managed compute environment.
	ComputeResources *types.ComputeResourceUpdate
	// The name or full Amazon Resource Name (ARN) of the compute environment to
	// update.
	ComputeEnvironment *string
	// The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to
	// make calls to other AWS services on your behalf. If your specified role has a
	// path other than /, then you must either specify the full role ARN (this is
	// recommended) or prefix the role name with the path. Depending on how you created
	// your AWS Batch service role, its ARN may contain the service-role path prefix.
	// When you only specify the name of the service role, AWS Batch assumes that your
	// ARN does not use the service-role path prefix. Because of this, we recommend
	// that you specify the full ARN of your service role when you create compute
	// environments.
	ServiceRole *string
	// The state of the compute environment. Compute environments in the ENABLED state
	// can accept jobs from a queue and scale in or out automatically based on the
	// workload demand of its associated queues.
	State types.CEState
}

type UpdateComputeEnvironmentOutput struct {
	// The name of the compute environment.
	ComputeEnvironmentName *string
	// The Amazon Resource Name (ARN) of the compute environment.
	ComputeEnvironmentArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateJobQueueInput struct {
	// Details the set of compute environments mapped to a job queue and their order
	// relative to each other. This is one of the parameters used by the job scheduler
	// to determine which compute environment should execute a given job.
	ComputeEnvironmentOrder []*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.
	Priority *int32
	// The name or the Amazon Resource Name (ARN) of the job queue.
	JobQueue *string
	// Describes the queue's ability to accept new jobs.
	State types.JQState
}

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
}