CommandExecuted

class SSM.Waiter.CommandExecuted

waiter = client.get_waiter('command_executed')

wait(**kwargs)

Polls SSM.Client.get_command_invocation() every 5 seconds until a successful state is reached. An error is returned after 20 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    CommandId='string',
    InstanceId='string',
    PluginName='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)

Parameters

• CommandId (string) --

  [REQUIRED]

  (Required) The parent command ID of the invocation plugin.

• InstanceId (string) --

  [REQUIRED]

  (Required) The ID of the managed node targeted by the command. A managed node can be an Amazon Elastic Compute Cloud (Amazon EC2) instance, edge device, and on-premises server or VM in your hybrid environment that is configured for Amazon Web Services Systems Manager.

• PluginName (string) --

  The name of the step for which you want detailed results. If the document contains only one step, you can omit the name and details for that step. If the document contains more than one step, you must specify the name of the step for which you want to view details. Be sure to specify the name of the step, not the name of a plugin like aws:RunShellScript .

  To find the PluginName , check the document content and find the name of the step you want details for. Alternatively, use ListCommandInvocations with the CommandId and Details parameters. The PluginName is the Name attribute of the CommandPlugin object in the CommandPlugins list.

• WaiterConfig (dict) --

  A dictionary that provides parameters to control waiting behavior.

  • Delay (integer) --

    The amount of time in seconds to wait between attempts. Default: 5

  • MaxAttempts (integer) --

    The maximum number of attempts to be made. Default: 20

Returns

None