amazonka-batch-2.0: Amazon Batch SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Batch.UpdateComputeEnvironment

Description

Updates an Batch compute environment.

Synopsis

Creating a Request

data UpdateComputeEnvironment Source #

Contains the parameters for UpdateComputeEnvironment.

See: newUpdateComputeEnvironment smart constructor.

Constructors

UpdateComputeEnvironment' 

Fields

  • computeResources :: Maybe ComputeResourceUpdate

    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.

  • serviceRole :: Maybe Text

    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.

  • state :: Maybe CEState

    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.

  • unmanagedvCpus :: Maybe Int

    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.

  • updatePolicy :: Maybe 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.

  • computeEnvironment :: Text

    The name or full Amazon Resource Name (ARN) of the compute environment to update.

Instances

Instances details
ToJSON UpdateComputeEnvironment Source # 
Instance details

Defined in Amazonka.Batch.UpdateComputeEnvironment

ToHeaders UpdateComputeEnvironment Source # 
Instance details

Defined in Amazonka.Batch.UpdateComputeEnvironment

ToPath UpdateComputeEnvironment Source # 
Instance details

Defined in Amazonka.Batch.UpdateComputeEnvironment

ToQuery UpdateComputeEnvironment Source # 
Instance details

Defined in Amazonka.Batch.UpdateComputeEnvironment

AWSRequest UpdateComputeEnvironment Source # 
Instance details

Defined in Amazonka.Batch.UpdateComputeEnvironment

Generic UpdateComputeEnvironment Source # 
Instance details

Defined in Amazonka.Batch.UpdateComputeEnvironment

Associated Types

type Rep UpdateComputeEnvironment :: Type -> Type #

Read UpdateComputeEnvironment Source # 
Instance details

Defined in Amazonka.Batch.UpdateComputeEnvironment

Show UpdateComputeEnvironment Source # 
Instance details

Defined in Amazonka.Batch.UpdateComputeEnvironment

NFData UpdateComputeEnvironment Source # 
Instance details

Defined in Amazonka.Batch.UpdateComputeEnvironment

Eq UpdateComputeEnvironment Source # 
Instance details

Defined in Amazonka.Batch.UpdateComputeEnvironment

Hashable UpdateComputeEnvironment Source # 
Instance details

Defined in Amazonka.Batch.UpdateComputeEnvironment

type AWSResponse UpdateComputeEnvironment Source # 
Instance details

Defined in Amazonka.Batch.UpdateComputeEnvironment

type Rep UpdateComputeEnvironment Source # 
Instance details

Defined in Amazonka.Batch.UpdateComputeEnvironment

type Rep UpdateComputeEnvironment = D1 ('MetaData "UpdateComputeEnvironment" "Amazonka.Batch.UpdateComputeEnvironment" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "UpdateComputeEnvironment'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "computeResources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ComputeResourceUpdate)) :*: (S1 ('MetaSel ('Just "serviceRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CEState)))) :*: (S1 ('MetaSel ('Just "unmanagedvCpus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "updatePolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UpdatePolicy)) :*: S1 ('MetaSel ('Just "computeEnvironment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

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.

Constructors

UpdateComputeEnvironmentResponse' 

Fields

Instances

Instances details
Generic UpdateComputeEnvironmentResponse Source # 
Instance details

Defined in Amazonka.Batch.UpdateComputeEnvironment

Associated Types

type Rep UpdateComputeEnvironmentResponse :: Type -> Type #

Read UpdateComputeEnvironmentResponse Source # 
Instance details

Defined in Amazonka.Batch.UpdateComputeEnvironment

Show UpdateComputeEnvironmentResponse Source # 
Instance details

Defined in Amazonka.Batch.UpdateComputeEnvironment

NFData UpdateComputeEnvironmentResponse Source # 
Instance details

Defined in Amazonka.Batch.UpdateComputeEnvironment

Eq UpdateComputeEnvironmentResponse Source # 
Instance details

Defined in Amazonka.Batch.UpdateComputeEnvironment

type Rep UpdateComputeEnvironmentResponse Source # 
Instance details

Defined in Amazonka.Batch.UpdateComputeEnvironment

type Rep UpdateComputeEnvironmentResponse = D1 ('MetaData "UpdateComputeEnvironmentResponse" "Amazonka.Batch.UpdateComputeEnvironment" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "UpdateComputeEnvironmentResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "computeEnvironmentArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "computeEnvironmentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

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_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 (_).