update_compute_environment ¶

def update_compute_environment(
    self,
    *,
    config_overrides: Optional[BatchClientConfig] = None,
    compute_environment: Optional["capo_batch.types.string.String"] = None,
    state: Optional["capo_batch.types.ce_state.CEState"] = None,
    unmanagedv_cpus: Optional["capo_batch.types.integer.Integer"] = None,
    compute_resources: Optional[
        "capo_batch.types.compute_resource_update.ComputeResourceUpdate"
    ] = None,
    service_role: Optional["capo_batch.types.string.String"] = None,
    update_policy: Optional["capo_batch.types.update_policy.UpdatePolicy"] = None,
    context: Optional["capo_batch.types.string.String"] = None,
    ecs_settings: Optional["capo_batch.types.ecs_settings.EcsSettings"] = None,
    eks_configuration: Optional[
        "capo_batch.types.eks_configuration_update.EksConfigurationUpdate"
    ] = None,
) -> "capo_batch.types.update_compute_environment_response.UpdateComputeEnvironmentResponse":
    """<p>Updates an Batch compute environment.</p>

    Args:
        compute_environment: <p>The name or full Amazon Resource Name (ARN) of the compute environment to update.</p>
        state: <p>The state of the compute environment. Compute environments in the <code>ENABLED</code> state can accept jobs from a queue and scale in or out automatically based on the workload demand of its associated queues.</p> <p>If the state is <code>ENABLED</code>, 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.</p> <p>If the state is <code>DISABLED</code>, then the Batch scheduler doesn't attempt to place jobs within the environment. Jobs in a <code>STARTING</code> or <code>RUNNING</code> state continue to progress normally. Managed compute environments in the <code>DISABLED</code> state don't scale out. </p> <note> <p>Compute environments in a <code>DISABLED</code> state may continue to incur billing charges, for example, if they have running instances due to jobs that are still executing or a non-zero <code>minvCpus</code> setting. To prevent additional charges, disable and delete the compute environment.</p> </note> <p>When an instance is idle, the instance scales down to the <code>minvCpus</code> value. However, the instance size doesn't change. For example, consider a <code>c5.8xlarge</code> instance with a <code>minvCpus</code> value of <code>4</code> and a <code>desiredvCpus</code> value of <code>36</code>. This instance doesn't scale down to a <code>c5.large</code> instance.</p>
        unmanagedv_cpus: <p>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.</p>
        compute_resources: <p>Details of the compute resources managed by the compute environment. Required for a managed compute environment. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html">Compute Environments</a> in the <i>Batch User Guide</i>.</p>
        service_role: <p>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 <a href="https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html">Batch service IAM role</a> in the <i>Batch User Guide</i>.</p> <important> <p>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 <b>AWSServiceRoleForBatch</b> service-linked role must be used. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html">Updating compute environments</a> in the <i>Batch User Guide</i>.</p> </important> <p>If your specified role has a path other than <code>/</code>, then you must either specify the full role ARN (recommended) or prefix the role name with the path.</p> <note> <p>Depending on how you created your Batch service role, its ARN might contain the <code>service-role</code> path prefix. When you only specify the name of the service role, Batch assumes that your ARN doesn't use the <code>service-role</code> path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.</p> </note>
        update_policy: <p>Specifies the updated infrastructure update policy for the compute environment. For more information about infrastructure updates, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html">Updating compute environments</a> in the <i>Batch User Guide</i>.</p>
        context: <p>Reserved.</p>
        ecs_settings: <p>The Amazon ECS settings for the compute environment. These settings control CloudWatch Container Insights collection for the compute environment.</p>
        eks_configuration: <p>Updates the Amazon EKS configuration for the compute environment. Only specify this parameter if the compute environment's <code>containerOrchestrationType</code> is <code>EKS</code>. Currently, the <code>accessEntry</code> setting is the only Amazon EKS configuration that you can change after the compute environment is created. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/eks-access-entries.html">Amazon EKS access entry authentication</a> in the <i>Batch User Guide</i>.</p>

    Raises:
        capo_batch.errors.client_exception.ClientException: <p>These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.</p>
        capo_batch.errors.server_exception.ServerException: <p>These errors are usually caused by a server issue.</p>
        capo_batch.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To update a compute environment
        This example disables the P2OnDemand compute environment so it can be deleted.

        >>> client.update_compute_environment(compute_environment='P2OnDemand', state='DISABLED')
    """

    def _handler(
        req: "OperationRequest[capo_batch.types.update_compute_environment_request.UpdateComputeEnvironmentRequest]",
    ) -> OperationResponse[
        "capo_batch.types.update_compute_environment_response.UpdateComputeEnvironmentResponse"
    ]:
        import capo_batch._operations.aws_batch_v20160810.update_compute_environment

        output, http_response = (
            capo_batch._operations.aws_batch_v20160810.update_compute_environment.update_compute_environment(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateComputeEnvironment")
    )
    input_: capo_batch.types.update_compute_environment_request.UpdateComputeEnvironmentRequest = {}
    if compute_environment is not None:
        input_["compute_environment"] = compute_environment
    if state is not None:
        input_["state"] = state
    if unmanagedv_cpus is not None:
        input_["unmanagedv_cpus"] = unmanagedv_cpus
    if compute_resources is not None:
        input_["compute_resources"] = compute_resources
    if service_role is not None:
        input_["service_role"] = service_role
    if update_policy is not None:
        input_["update_policy"] = update_policy
    if context is not None:
        input_["context"] = context
    if ecs_settings is not None:
        input_["ecs_settings"] = ecs_settings
    if eks_configuration is not None:
        input_["eks_configuration"] = eks_configuration

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output