ElasticBeanstalk / Client / describe_environment_managed_action_history

describe_environment_managed_action_history#

ElasticBeanstalk.Client.describe_environment_managed_action_history(**kwargs)#

Lists an environment’s completed and failed managed actions.

See also: AWS API Documentation

Request Syntax

response = client.describe_environment_managed_action_history(
    EnvironmentId='string',
    EnvironmentName='string',
    NextToken='string',
    MaxItems=123
)
Parameters:

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

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

  • NextToken (string) – The pagination token returned by a previous request.

  • MaxItems (integer) – The maximum number of items to return for a single request.

Return type:

dict

Returns:

Response Syntax

{
    'ManagedActionHistoryItems': [
        {
            'ActionId': 'string',
            'ActionType': 'InstanceRefresh'|'PlatformUpdate'|'Unknown',
            'ActionDescription': 'string',
            'FailureType': 'UpdateCancelled'|'CancellationFailed'|'RollbackFailed'|'RollbackSuccessful'|'InternalFailure'|'InvalidEnvironmentState'|'PermissionsError',
            'Status': 'Completed'|'Failed'|'Unknown',
            'FailureDescription': 'string',
            'ExecutedTime': datetime(2015, 1, 1),
            'FinishedTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    A result message containing a list of completed and failed managed actions.

    • ManagedActionHistoryItems (list) –

      A list of completed and failed managed actions.

      • (dict) –

        The record of a completed or failed managed action.

        • ActionId (string) –

          A unique identifier for the managed action.

        • ActionType (string) –

          The type of the managed action.

        • ActionDescription (string) –

          A description of the managed action.

        • FailureType (string) –

          If the action failed, the type of failure.

        • Status (string) –

          The status of the action.

        • FailureDescription (string) –

          If the action failed, a description of the failure.

        • ExecutedTime (datetime) –

          The date and time that the action started executing.

        • FinishedTime (datetime) –

          The date and time that the action finished executing.

    • NextToken (string) –

      A pagination token that you pass to DescribeEnvironmentManagedActionHistory to get the next page of results.

Exceptions