ElasticBeanstalk / Client / apply_environment_managed_action

apply_environment_managed_action#

ElasticBeanstalk.Client.apply_environment_managed_action(**kwargs)#

Applies a scheduled managed action immediately. A managed action can be applied only if its status is Scheduled. Get the status and action ID of a managed action with DescribeEnvironmentManagedActions.

See also: AWS API Documentation

Request Syntax

response = client.apply_environment_managed_action(
    EnvironmentName='string',
    EnvironmentId='string',
    ActionId='string'
)
Parameters:

  • EnvironmentName (string) – The name of the target environment.

  • EnvironmentId (string) – The environment ID of the target environment.

  • ActionId (string) –

    [REQUIRED]

    The action ID of the scheduled managed action to execute.

Return type:

dict

Returns:

Response Syntax

{
    'ActionId': 'string',
    'ActionDescription': 'string',
    'ActionType': 'InstanceRefresh'|'PlatformUpdate'|'Unknown',
    'Status': 'string'
}

Response Structure

  • (dict) –

    The result message containing information about the managed action.

    • ActionId (string) –

      The action ID of the managed action.

    • ActionDescription (string) –

      A description of the managed action.

    • ActionType (string) –

      The type of managed action.

    • Status (string) –

      The status of the managed action.

Exceptions

  • ElasticBeanstalk.Client.exceptions.ElasticBeanstalkServiceException

  • ElasticBeanstalk.Client.exceptions.ManagedActionInvalidStateException