Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Updates an Batch compute environment.
Synopsis
- data UpdateComputeEnvironment = UpdateComputeEnvironment' {}
- newUpdateComputeEnvironment :: Text -> UpdateComputeEnvironment
- updateComputeEnvironment_computeResources :: Lens' UpdateComputeEnvironment (Maybe ComputeResourceUpdate)
- updateComputeEnvironment_serviceRole :: Lens' UpdateComputeEnvironment (Maybe Text)
- updateComputeEnvironment_state :: Lens' UpdateComputeEnvironment (Maybe CEState)
- updateComputeEnvironment_unmanagedvCpus :: Lens' UpdateComputeEnvironment (Maybe Int)
- updateComputeEnvironment_updatePolicy :: Lens' UpdateComputeEnvironment (Maybe UpdatePolicy)
- updateComputeEnvironment_computeEnvironment :: Lens' UpdateComputeEnvironment Text
- data UpdateComputeEnvironmentResponse = UpdateComputeEnvironmentResponse' {}
- newUpdateComputeEnvironmentResponse :: Int -> UpdateComputeEnvironmentResponse
- updateComputeEnvironmentResponse_computeEnvironmentArn :: Lens' UpdateComputeEnvironmentResponse (Maybe Text)
- updateComputeEnvironmentResponse_computeEnvironmentName :: Lens' UpdateComputeEnvironmentResponse (Maybe Text)
- updateComputeEnvironmentResponse_httpStatus :: Lens' UpdateComputeEnvironmentResponse Int
Creating a Request
data UpdateComputeEnvironment Source #
Contains the parameters for UpdateComputeEnvironment
.
See: newUpdateComputeEnvironment
smart constructor.
UpdateComputeEnvironment' | |
|
Instances
newUpdateComputeEnvironment Source #
Create a value of UpdateComputeEnvironment
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateComputeEnvironment
, updateComputeEnvironment_computeResources
- Details of the compute resources managed by the compute environment.
Required for a managed compute environment. For more information, see
Compute Environments
in the Batch User Guide.
UpdateComputeEnvironment
, updateComputeEnvironment_serviceRole
- The full Amazon Resource Name (ARN) of the IAM role that allows Batch to
make calls to other Amazon Web Services services on your behalf. For
more information, see
Batch service IAM role
in the Batch User Guide.
If the compute environment has a service-linked role, it can't be changed to use a regular IAM role. Likewise, if the compute environment has a regular IAM role, it can't be changed to use a service-linked role. To update the parameters for the compute environment that require an infrastructure update to change, the AWSServiceRoleForBatch service-linked role must be used. For more information, see Updating compute environments in the Batch User Guide.
If your specified role has a path other than /
, then you must either
specify the full role ARN (recommended) or prefix the role name with the
path.
Depending on how you created your Batch service role, its ARN might
contain the service-role
path prefix. When you only specify the name
of the service role, 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.
UpdateComputeEnvironment
, updateComputeEnvironment_state
- 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 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 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.
UpdateComputeEnvironment
, updateComputeEnvironment_unmanagedvCpus
- The maximum number of vCPUs expected to be used for an unmanaged compute
environment. Don't specify this parameter for a managed compute
environment. This parameter is only used for fair share scheduling to
reserve vCPU capacity for new share identifiers. If this parameter
isn't provided for a fair share job queue, no vCPU capacity is
reserved.
UpdateComputeEnvironment
, updateComputeEnvironment_updatePolicy
- Specifies the updated infrastructure update policy for the compute
environment. For more information about infrastructure updates, see
Updating compute environments
in the Batch User Guide.
UpdateComputeEnvironment
, updateComputeEnvironment_computeEnvironment
- The name or full Amazon Resource Name (ARN) of the compute environment
to update.
Request Lenses
updateComputeEnvironment_computeResources :: Lens' UpdateComputeEnvironment (Maybe ComputeResourceUpdate) Source #
Details of the compute resources managed by the compute environment. Required for a managed compute environment. For more information, see Compute Environments in the Batch User Guide.
updateComputeEnvironment_serviceRole :: Lens' UpdateComputeEnvironment (Maybe Text) Source #
The full Amazon Resource Name (ARN) of the IAM role that allows Batch to make calls to other Amazon Web Services services on your behalf. For more information, see Batch service IAM role in the Batch User Guide.
If the compute environment has a service-linked role, it can't be changed to use a regular IAM role. Likewise, if the compute environment has a regular IAM role, it can't be changed to use a service-linked role. To update the parameters for the compute environment that require an infrastructure update to change, the AWSServiceRoleForBatch service-linked role must be used. For more information, see Updating compute environments in the Batch User Guide.
If your specified role has a path other than /
, then you must either
specify the full role ARN (recommended) or prefix the role name with the
path.
Depending on how you created your Batch service role, its ARN might
contain the service-role
path prefix. When you only specify the name
of the service role, 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.
updateComputeEnvironment_state :: Lens' UpdateComputeEnvironment (Maybe CEState) Source #
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 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 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.
updateComputeEnvironment_unmanagedvCpus :: Lens' UpdateComputeEnvironment (Maybe Int) Source #
The maximum number of vCPUs expected to be used for an unmanaged compute environment. Don't specify this parameter for a managed compute environment. This parameter is only used for fair share scheduling to reserve vCPU capacity for new share identifiers. If this parameter isn't provided for a fair share job queue, no vCPU capacity is reserved.
updateComputeEnvironment_updatePolicy :: Lens' UpdateComputeEnvironment (Maybe UpdatePolicy) Source #
Specifies the updated infrastructure update policy for the compute environment. For more information about infrastructure updates, see Updating compute environments in the Batch User Guide.
updateComputeEnvironment_computeEnvironment :: Lens' UpdateComputeEnvironment Text Source #
The name or full Amazon Resource Name (ARN) of the compute environment to update.
Destructuring the Response
data UpdateComputeEnvironmentResponse Source #
See: newUpdateComputeEnvironmentResponse
smart constructor.
UpdateComputeEnvironmentResponse' | |
|
Instances
newUpdateComputeEnvironmentResponse Source #
Create a value of UpdateComputeEnvironmentResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateComputeEnvironmentResponse
, updateComputeEnvironmentResponse_computeEnvironmentArn
- The Amazon Resource Name (ARN) of the compute environment.
UpdateComputeEnvironmentResponse
, updateComputeEnvironmentResponse_computeEnvironmentName
- The name of the compute environment. It can be up to 128 characters
long. It can contain uppercase and lowercase letters, numbers, hyphens
(-), and underscores (_).
$sel:httpStatus:UpdateComputeEnvironmentResponse'
, updateComputeEnvironmentResponse_httpStatus
- The response's http status code.
Response Lenses
updateComputeEnvironmentResponse_computeEnvironmentArn :: Lens' UpdateComputeEnvironmentResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the compute environment.
updateComputeEnvironmentResponse_computeEnvironmentName :: Lens' UpdateComputeEnvironmentResponse (Maybe Text) Source #
The name of the compute environment. It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
updateComputeEnvironmentResponse_httpStatus :: Lens' UpdateComputeEnvironmentResponse Int Source #
The response's http status code.