ElasticBeanstalk / Client / abort_environment_update

abort_environment_update#

ElasticBeanstalk.Client.abort_environment_update(**kwargs)#

Cancels in-progress environment configuration update or application version deployment.

See also: AWS API Documentation

Request Syntax

response = client.abort_environment_update(
    EnvironmentId='string',
    EnvironmentName='string'
)
Parameters:
  • EnvironmentId (string) – This specifies the ID of the environment with the in-progress update that you want to cancel.

  • EnvironmentName (string) – This specifies the name of the environment with the in-progress update that you want to cancel.

Returns:

None

Exceptions

  • ElasticBeanstalk.Client.exceptions.InsufficientPrivilegesException

Examples

The following code aborts a running application version deployment for an environment named my-env:

response = client.abort_environment_update(
    EnvironmentName='my-env',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}