ElasticBeanstalk / Client / describe_environment_managed_actions

describe_environment_managed_actions#

ElasticBeanstalk.Client.describe_environment_managed_actions(**kwargs)#

Lists an environment’s upcoming and in-progress managed actions.

See also: AWS API Documentation

Request Syntax

response = client.describe_environment_managed_actions(
    EnvironmentName='string',
    EnvironmentId='string',
    Status='Scheduled'|'Pending'|'Running'|'Unknown'
)
Parameters:

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

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

  • Status (string) – To show only actions with a particular status, specify a status.

Return type:

dict

Returns:

Response Syntax

{
    'ManagedActions': [
        {
            'ActionId': 'string',
            'ActionDescription': 'string',
            'ActionType': 'InstanceRefresh'|'PlatformUpdate'|'Unknown',
            'Status': 'Scheduled'|'Pending'|'Running'|'Unknown',
            'WindowStartTime': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

  • (dict) –

    The result message containing a list of managed actions.

    • ManagedActions (list) –

      A list of upcoming and in-progress managed actions.

      • (dict) –

        The record of an upcoming or in-progress managed action.

        • ActionId (string) –

          A unique identifier for 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. If the action is Scheduled , you can apply it immediately with ApplyEnvironmentManagedAction.

        • WindowStartTime (datetime) –

          The start time of the maintenance window in which the managed action will execute.

Exceptions

  • ElasticBeanstalk.Client.exceptions.ElasticBeanstalkServiceException