MainframeModernization / Client / update_environment

update_environment#

MainframeModernization.Client.update_environment(**kwargs)#

Updates the configuration details for a specific runtime environment.

See also: AWS API Documentation

Request Syntax

response = client.update_environment(
    applyDuringMaintenanceWindow=True|False,
    desiredCapacity=123,
    engineVersion='string',
    environmentId='string',
    instanceType='string',
    preferredMaintenanceWindow='string'
)
Parameters:

  • applyDuringMaintenanceWindow (boolean) – Indicates whether to update the runtime environment during the maintenance window. The default is false. Currently, Amazon Web Services Mainframe Modernization accepts the engineVersion parameter only if applyDuringMaintenanceWindow is true. If any parameter other than engineVersion is provided in UpdateEnvironmentRequest , it will fail if applyDuringMaintenanceWindow is set to true.

  • desiredCapacity (integer) – The desired capacity for the runtime environment to update.

  • engineVersion (string) – The version of the runtime engine for the runtime environment.

  • environmentId (string) –

    [REQUIRED]

    The unique identifier of the runtime environment that you want to update.

  • instanceType (string) – The instance type for the runtime environment to update.

  • preferredMaintenanceWindow (string) – Configures the maintenance window you want for the runtime environment. If you do not provide a value, a random system-generated value will be assigned.

Return type:

dict

Returns:

Response Syntax

{
    'environmentId': 'string'
}

Response Structure

  • (dict) –

    • environmentId (string) –

      The unique identifier of the runtime environment that was updated.

Exceptions

  • MainframeModernization.Client.exceptions.ValidationException

  • MainframeModernization.Client.exceptions.ServiceQuotaExceededException

  • MainframeModernization.Client.exceptions.ConflictException

  • MainframeModernization.Client.exceptions.InternalServerException

  • MainframeModernization.Client.exceptions.AccessDeniedException

  • MainframeModernization.Client.exceptions.ThrottlingException

  • MainframeModernization.Client.exceptions.ResourceNotFoundException