Class: Aws::SSM::Waiters::CommandExecuted

Inherits:

Object

• Object
• Aws::SSM::Waiters::CommandExecuted

Defined in:

sig/waiters.rbs,
lib/aws-sdk-ssm/waiters.rb

Instance Attribute Summary

• #waiter ⇒ Object readonly private

Instance Method Summary

• #initialize(options) ⇒ CommandExecuted constructor

  A new instance of CommandExecuted.

• #wait(params = {}) ⇒ Types::GetCommandInvocationResult

  Returns a response object which responds to the following methods:.

Constructor Details

#initialize(options) ⇒ CommandExecuted

Returns a new instance of CommandExecuted.

Parameters:

• options (Hash)

Options Hash (options):

• :client (required, Client)
• :max_attempts (Integer) — default: 20
• :delay (Integer) — default: 5
• :before_attempt (Proc)
• :before_wait (Proc)

# File 'lib/aws-sdk-ssm/waiters.rb', line 84

def initialize: (?client: Client, ?max_attempts: Integer, ?delay: Integer, ?before_attempt: Proc, ?before_wait: Proc) -> void
| (?Hash[Symbol, untyped]) -> void

Instance Attribute Details

#waiter ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'lib/aws-sdk-ssm/waiters.rb', line 157

def waiter
  @waiter
end

Instance Method Details

#wait(params = {}) ⇒ Types::GetCommandInvocationResult

Returns a response object which responds to the following methods:

• #command_id => String
• #instance_id => String
• #comment => String
• #document_name => String
• #document_version => String
• #plugin_name => String
• #response_code => Integer
• #execution_start_date_time => String
• #execution_elapsed_time => String
• #execution_end_date_time => String
• #status => String
• #status_details => String
• #standard_output_content => String
• #standard_output_url => String
• #standard_error_content => String
• #standard_error_url => String
• #cloud_watch_output_config => Types::CloudWatchOutputConfig

Options Hash (params):

• :command_id (required, String) — default: Required —

  The parent command ID of the invocation plugin.

• :instance_id (required, String) — default: 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 (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.

Returns:

• (Types::GetCommandInvocationResult) —

  Returns a response object which responds to the following methods:

  • #command_id => String
  • #instance_id => String
  • #comment => String
  • #document_name => String
  • #document_version => String
  • #plugin_name => String
  • #response_code => Integer
  • #execution_start_date_time => String
  • #execution_elapsed_time => String
  • #execution_end_date_time => String
  • #status => String
  • #status_details => String
  • #standard_output_content => String
  • #standard_output_url => String
  • #standard_error_content => String
  • #standard_error_url => String
  • #cloud_watch_output_config => Types::CloudWatchOutputConfig

# File 'lib/aws-sdk-ssm/waiters.rb', line 152

def wait: (