ElasticBeanstalk / Client / restart_app_server

restart_app_server

ElasticBeanstalk.Client.restart_app_server(**kwargs)

Causes the environment to restart the application container server running on each Amazon EC2 instance.

See also: AWS API Documentation

Request Syntax

response = client.restart_app_server(
    EnvironmentId='string',
    EnvironmentName='string'
)

Parameters:

• EnvironmentId (string) –

  The ID of the environment to restart the server for.

  Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

• EnvironmentName (string) –

  The name of the environment to restart the server for.

  Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

Returns:

None

Examples

The following operation restarts application servers on all instances in an environment named my-env:

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

print(response)

Expected Output:

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