AWS Elastic Beanstalk

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.

Request Syntax

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

type EnvironmentName

string

param EnvironmentName

The name of the target environment.

type EnvironmentId

string

param EnvironmentId

The environment ID of the target environment.

type ActionId

string

param ActionId

[REQUIRED]

The action ID of the scheduled managed action to execute.

rtype

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.

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

Request Syntax

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

type EnvironmentName

string

param EnvironmentName

The name of the target environment.

type EnvironmentId

string

param EnvironmentId

The environment ID of the target environment.

type Status

string

param Status

To show only actions with a particular status, specify a status.

rtype

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.

Lists an environment's completed and failed managed actions.

Request Syntax

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

type EnvironmentId

string

param EnvironmentId

The environment ID of the target environment.

type EnvironmentName

string

param EnvironmentName

The name of the target environment.

type NextToken

string

param NextToken

The pagination token returned by a previous request.

type MaxItems

integer

param MaxItems

The maximum number of items to return for a single request.

rtype

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.