Skip to content

GetCommandInvocationRequest

Source code in docs_src/capo_ssm/types/get_command_invocation_request.py 
15
16
17
18
19
20
21
class GetCommandInvocationRequest(TypedDict, closed=True):
    command_id: "capo_ssm.types.command_id.CommandId"
    """<p>(Required) The parent command ID of the invocation plugin.</p>"""
    instance_id: "capo_ssm.types.instance_id.InstanceId"
    """<p>(Required) The ID of the managed node targeted by the command. A <i>managed node</i> 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.</p>"""
    plugin_name: NotRequired["capo_ssm.types.command_plugin_name.CommandPluginName"]
    """<p>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 <code>aws:RunShellScript</code>.</p> <p>To find the <code>PluginName</code>, check the document content and find the name of the step you want details for. Alternatively, use <a>ListCommandInvocations</a> with the <code>CommandId</code> and <code>Details</code> parameters. The <code>PluginName</code> is the <code>Name</code> attribute of the <code>CommandPlugin</code> object in the <code>CommandPlugins</code> list.</p>"""

command_id instance-attribute 

command_id: CommandId

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

instance_id instance-attribute 

instance_id: InstanceId

(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.

plugin_name instance-attribute 

plugin_name: NotRequired[CommandPluginName]

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.