ElasticBeanstalk / Paginator / DescribeEnvironmentManagedActionHistory

DescribeEnvironmentManagedActionHistory

class ElasticBeanstalk.Paginator.DescribeEnvironmentManagedActionHistory

paginator = client.get_paginator('describe_environment_managed_action_history')

paginate(**kwargs)

Creates an iterator that will paginate through responses from ElasticBeanstalk.Client.describe_environment_managed_action_history().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    EnvironmentId='string',
    EnvironmentName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

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

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

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

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)
        },
    ],

}

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.